Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Webhooks

Create a webhook endpoint

After creating a webhook endpoint, we will POST to the webhook URL whenever certain events happen in our system.

post/webhook/endpoints

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

urlstring required

The URL that webhook events should be POSTed to.

arc_versionstring

The version of the Arcadia API this endpoint is designed to understand. The JSON body corresponding to a webhook event type may change across versions. Arcadia will continue to send events to this endpoint using the event schemas as they existed in the selected version, insulating you from breaking changes.

Example request

{
  "url": "https://example.com/webhook-endpoint",
  "arc_version": "2022-10-13"
}

Response

Success

created_atstring date-time required
updated_atstring date-time required
idstring uuid required
signing_keystring required
urlstring required
sandboxedboolean required
enabledboolean required
arc_versionstring required

Example response

{
  "id": "3847dd41-8c90-499a-ac6e-10a027dd231f",
  "signing_key": "MIZ1ImBK1FiVisS1",
  "url": "https://example.com/webhook-endpoint",
  "enabled": true,
  "arc_version": "2022-10-13"
}