Table of Contents |
---|
maxLevel | 3 |
---|
outline | true |
---|
style | circle |
---|
|
Warning |
---|
|
Webhooks are in open beta. The events are limited and subject to change. Please don't hesitate to provide feedback or suggestions. If there are events that would be most useful to you, please reach out to us. |
...
Header | Description |
---|
X-Accelo-Event | ID of the even that triggered the delivery. For example, "assign_task" |
X-Hub-Signature | HMAC hex digest of the payload using your configured subscriptions secret. |
...
Endpoints
You can manage webhooks from the public api. This is particularly useful if you wish your integration to automatically manage subscriptions on behalf of authorized user.
...
Code Block |
---|
POST /api/v0/webhooks/subscriptions.{json|xml|yml} |
Parameters
name | description |
---|
trigger_url | URL we will trigger a HTTP POST to upon firing the registered event. For example, "https://your-domain.com/callback". |
event_id | Unique event identifier. You can grab a list of possible subscription events from the get subscription types endpoint. |
Sample Response
Code Block |
---|
|
POST /api/v0/webhooks/subscriptions HTTP/1.1
Host: your-deployment.api.accelo.com
Content-Type: application/json
{
"trigger_url": "https://your-domain.com/callback",
"event_id": "assign_task"
} |
...