SparrowDesk
Webhook targets

Subscribe a webhook target

Registers an endpoint URL to receive deliveries for a supported event type. Requires the "MANAGE_WEBHOOKS" scope and the account's plan to include the Webhooks feature. The response's signing_secret is shown once and used to verify the X-Sparrowdesk-Signature header on each delivery.

POST
/webhooks
AuthorizationBearer <token>

In: header

endpoint_urlstring
Formaturi
event_typestring

Response Body

application/json

application/json

application/json

curl -X POST "https://app.sparrowdesk.com/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "endpoint_url": "https://hooks.zapier.com/hooks/standard/123456/abcdef/",    "event_type": "conversation.created"  }'
{
  "data": {
    "id": 0,
    "endpoint_url": "string",
    "event_type": "string",
    "enabled": true,
    "created_at": 0,
    "signing_secret": "string"
  }
}
{
  "error": {
    "message": "string"
  }
}
{
  "error": {
    "message": "string"
  }
}