v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB

Webhooks

Update a webhook endpoint

Updates a single webhook endpoint specified by ID.

patch/webhook/endpoints/{webhook_endpoint_id}

Path parameters

webhook_endpoint_idstring required

Example:3847dd41-8c90-499a-ac6e-10a027dd231f

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

enabledboolean

Determines whether this webhook endpoint will receive webhook events. Webhook endpoints that are enabled: true will receive webhook events. Webhook endpoints that are enabled: false will not receive webhook events

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

{
  "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"
}