Sign in
Webhook

Create a webhook

    If you would like to use our webhook service, please contact support@encircleapp.com
post/v1/webhooks

Headers

X-Encircle-Attributionstring

String used to internally identify which integrator made this request on behalf of their users.

Integrators should reuse the same 'X-Encircle-Attribution' value for all their users.

This attribution enables Encircle to provide better assistance to integrators if they encounter any issues.

If not specified, the request will not be associated with any integration services.

X-Encircle-Requeststring

Unique string used to identify each specific request.

Any retries due to connection failures should reuse the same 'X-Encircle-Request' value. This helps prevent duplicate requests from unintentionally being processed again.

If not specified, the request will be treated as unique and it will be processed normally.

Request body

delivery_urlstring required

An HTTPS endpoint URL the Webhook will deliver payloads to. The URL should be unique per Organization / bearer token so your system can authenticate any necessary follow-up requests.

Your domain must also be whitelisted, contact support@encircleapp.com

If the status code returned by the endpoint is 410, then a resource required to fire the appropriate Webhook event is unavailable, at which point the Webhook will stop listening for that event.

eventsstring[] required

Example request

{
  "authentication": {
    "type": "shared_secret"
  }
}

Response

The Webhook was created successfully.

idinteger required

The id of the Webhook.

delivery_urlstring required

An HTTPS endpoint URL the Webhook will deliver payloads to. The URL should be unique per Organization / bearer token so your system can authenticate any necessary follow-up requests.

Your domain must also be whitelisted, contact support@encircleapp.com

If the status code returned by the endpoint is 410, then a resource required to fire the appropriate Webhook event is unavailable, at which point the Webhook will stop listening for that event.

eventsstring[] required

Example response

{
  "authentication": {
    "type": "shared_secret"
  }
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.