Webhooks

Update a webhook endpoint

Changed on

Partial update; omitted fields keep their value. The secret is not changed — use POST /v1/webhook-endpoints/{id}/roll-secret.

patch/v1/webhook-endpoints/{endpoint_id}

Request

  • Base URL: https://api-eu.dynamicdocumentapi.com
  • URL: https://api-eu.dynamicdocumentapi.com/v1/webhook-endpoints/{endpoint_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

endpoint_idstring required

Webhook endpoint id (whe_…).

Request body

descriptionstring
enabledboolean
eventsstring[]
headersobject

Extra request headers.

is_defaultboolean

Receive events from renders without an inline webhook.

managed_by'zapier' | 'make' | 'n8n' | 'bubble' | 'pipedream' | 'activepieces' | 'power_automate'

Create only. Set from the OAuth token when it belongs to an integration's app (e.g. Zapier's), which may send the same value; API keys can't set it.

  • zapier - zapier
  • make - make
  • n8n - n8n
  • bubble - bubble
  • pipedream - pipedream
  • activepieces - activepieces
  • power_automate - power_automate
template_idsstring[]

Only deliver events for these templates.

urlstring uri

Absolute https URL with a public host and no credentials, on port 443, 80, 8080 or 8443.

Response

created_atstring date-time required
descriptionstring required
disabled_reasonstring nullable required

Set when Dynamic Document API disabled the endpoint after repeated failures, or because its URL answered 410 Gone.

enabledboolean required
eventsstring[] required
headersobject required

Header names; the values are masked.

idstring required

whe_…

is_defaultboolean required
managed_by'zapier' | 'make' | 'n8n' | 'bubble' | 'pipedream' | 'activepieces' | 'power_automate' | 'null' nullable required

The integration (e.g. zapier) that created the endpoint for its instant triggers; null for your own endpoints. It is never the default endpoint, the dashboard shows it read-only, and it is deleted when you disconnect the integration or when its URL answers 410 Gone.

  • zapier - zapier
  • make - make
  • n8n - n8n
  • bubble - bubble
  • pipedream - pipedream
  • activepieces - activepieces
  • power_automate - power_automate
objectstring
template_idsstring[] required

Empty list = every template.

updated_atstring date-time required
urlstring uri required

Changes

  • 0f14bc0000f4Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status