Webhooks & events

List webhook endpoints#

SDKlistener.webhookEndpoints.list()client.webhook_endpoints.list()

OK

• objectstringrequired
• urlstringrequired
• dataarray of objectsrequired
  Show child attributesHide child attributes
• has_morebooleanrequired
• next_cursorstringrequirednullable
  Pass as cursor to get the next page; null on the last page.
• metaobjectrequired
  The result's non-list fields (window, coverage, freshness, totals, note …).

400parameter_invalid401credential_invalid403scope_missing404resource_not_found429rate_limited500internal_error

Create a webhook endpoint#

SDKlistener.webhookEndpoints.create()client.webhook_endpoints.create()

• Idempotency-Keystringmax 255 chars
  Any unique string (≤ 255 chars). Replays within 24 h return the stored response with Idempotent-Replayed: true.

• urlstringrequired
  HTTPS URL that receives POSTed events.
• enabled_eventsarray of stringsrequired
  Event types to deliver, or ["*"] for all. See GET /v1/event-types.
• descriptionstringnullable
  Free-text note shown in the dashboard.
• dry_runboolean
  Validate and return what would be written without calling the service.

  Default false

OK

400parameter_invalid401credential_invalid403scope_missing404resource_not_found409confirmation_required413body_too_large429rate_limited500internal_error

Retrieve a webhook endpoint#

SDKlistener.webhookEndpoints.retrieve()client.webhook_endpoints.retrieve()

• endpoint_idstringrequired
  Webhook endpoint id (we_…).

OK

• objectanyrequired
• idstringrequired
  we_…
• urlstring (uri)required
• enabled_eventsarray of stringsrequired
• statusstringrequired
  One ofenableddisabled
• descriptionstringnullable
• disabled_reasonstringnullable
• secretstring
  whsec_… — returned only on create and roll-secret.
• secret_last4string
• expires_previous_atstring (date-time)nullable
• api_versionstring
• created_atstring (date-time)
• updated_atstring (date-time)

400parameter_invalid401credential_invalid403scope_missing404resource_not_found429rate_limited500internal_error

Update a webhook endpoint#

SDKlistener.webhookEndpoints.update()client.webhook_endpoints.update()

• endpoint_idstringrequired
  Webhook endpoint id (we_…).

• Idempotency-Keystringmax 255 chars
  Any unique string (≤ 255 chars). Replays within 24 h return the stored response with Idempotent-Replayed: true.

• urlstringnullable
  New HTTPS URL.
• enabled_eventsarray of stringsnullable
  Event types to deliver, or ["*"].
• descriptionstringnullable
  Free-text note.
• disabledbooleannullable
  true pauses deliveries; false re-enables the endpoint.
• dry_runboolean
  Validate and return what would be written without calling the service.

  Default false

OK

400parameter_invalid401credential_invalid403scope_missing404resource_not_found409confirmation_required413body_too_large429rate_limited500internal_error

Delete a webhook endpoint#

SDKlistener.webhookEndpoints.delete()client.webhook_endpoints.delete()

• endpoint_idstringrequired
  Webhook endpoint id (we_…).

• dry_runboolean
  Validate and return what would be written without calling the service.

  Default false

• Idempotency-Keystringmax 255 chars
  Any unique string (≤ 255 chars). Replays within 24 h return the stored response with Idempotent-Replayed: true.

OK

400parameter_invalid401credential_invalid403scope_missing404resource_not_found409confirmation_required413body_too_large429rate_limited500internal_error

Roll a webhook signing secret#

SDKlistener.webhookEndpoints.rollSecret()client.webhook_endpoints.roll_secret()

• endpoint_idstringrequired
  Webhook endpoint id (we_…).

• Idempotency-Keystringmax 255 chars
  Any unique string (≤ 255 chars). Replays within 24 h return the stored response with Idempotent-Replayed: true.

• expire_previous_in_hoursinteger
  Hours the previous secret keeps signing (0–168).

  Default 24

• dry_runboolean
  Validate and return what would be written without calling the service.

  Default false

OK

400parameter_invalid401credential_invalid403scope_missing404resource_not_found409confirmation_required413body_too_large429rate_limited500internal_error

Reveal a webhook signing secret#

SDKlistener.webhookEndpoints.retrieveSecret()client.webhook_endpoints.retrieve_secret()

• endpoint_idstringrequired
  Webhook endpoint id (we_…).

OK

• objectanyrequired
• idstringrequired
  we_…
• secretstringrequired
  whsec_… — verify Listener-Signature with it.
• secret_last4stringnullable
• previous_secret_expires_atstring (date-time)nullable
  Set while a rolled secret still signs deliveries.

400parameter_invalid401credential_invalid403scope_missing404resource_not_found429rate_limited500internal_error

Send a test event#

SDKlistener.webhookEndpoints.test()client.webhook_endpoints.test()

• endpoint_idstringrequired
  Webhook endpoint id (we_…).

• Idempotency-Keystringmax 255 chars
  Any unique string (≤ 255 chars). Replays within 24 h return the stored response with Idempotent-Replayed: true.

• event_typestring
  Event type to send.

  Default "webhook_endpoint.test"

• dry_runboolean
  Validate and return what would be written without calling the service.

  Default false

OK

400parameter_invalid401credential_invalid403scope_missing404resource_not_found409confirmation_required413body_too_large429rate_limited500internal_error

List recent deliveries#

SDKlistener.webhookEndpoints.deliveries.list()client.webhook_endpoints.deliveries.list()

• endpoint_idstringrequired
  Webhook endpoint id (we_…).

• limitinteger1 to 100
  Page size, 1–100 (default 25).

  Default 25

• cursorstring
  Opaque cursor from the previous page's next_cursor.

OK

• objectstringrequired
• urlstringrequired
• dataarray of objectsrequired
  Show child attributesHide child attributes
• has_morebooleanrequired
• next_cursorstringrequirednullable
  Pass as cursor to get the next page; null on the last page.
• metaobjectrequired
  The result's non-list fields (window, coverage, freshness, totals, note …).

400parameter_invalid401credential_invalid403scope_missing404resource_not_found429rate_limited500internal_error

Retry a delivery#

SDKlistener.webhookDeliveries.retry()client.webhook_deliveries.retry()

• delivery_idstringrequired
  Delivery id (wd_…).

• Idempotency-Keystringmax 255 chars
  Any unique string (≤ 255 chars). Replays within 24 h return the stored response with Idempotent-Replayed: true.

• dry_runboolean
  Validate and return what would be written without calling the service.

  Default false

OK

400parameter_invalid401credential_invalid403scope_missing404resource_not_found409confirmation_required413body_too_large429rate_limited500internal_error

List events#

SDKlistener.events.list()client.events.list()

• typestringnullable
  Only events of this type (e.g. campaign.updated).
• created_gtestringnullable
  Only events created at or after this ISO 8601 time.
• created_ltestringnullable
  Only events created at or before this ISO 8601 time.
• limitinteger1 to 100
  Page size, 1–100 (default 25).

  Default 25

• cursorstring
  Opaque cursor from the previous page's next_cursor.

OK

• objectstringrequired
• urlstringrequired
• dataarray of objectsrequired
  Show child attributesHide child attributes
• has_morebooleanrequired
• next_cursorstringrequirednullable
  Pass as cursor to get the next page; null on the last page.
• metaobjectrequired
  The result's non-list fields (window, coverage, freshness, totals, note …).

400parameter_invalid401credential_invalid403scope_missing404resource_not_found429rate_limited500internal_error

Retrieve an event#

SDKlistener.events.retrieve()client.events.retrieve()

• event_idstringrequired
  Event id (evt_…).

OK

• objectanyrequired
• idstringrequired
  evt_…
• typestringrequired
• createdstring (date-time)required
• dataobjectrequired
  Show child attributesHide child attributes
• api_versionstring
• workspace_idstring
• sourcestring
  One ofapiappsystem
• requestobjectnullable
  Show child attributesHide child attributes

400parameter_invalid401credential_invalid403scope_missing404resource_not_found429rate_limited500internal_error

List event types#

SDKlistener.eventTypes.list()client.event_types.list()

OK

• objectstringrequired
• urlstringrequired
• dataarray of objectsrequired
  Show child attributesHide child attributes
• has_morebooleanrequired
• next_cursorstringrequirednullable
  Pass as cursor to get the next page; null on the last page.
• metaobjectrequired
  The result's non-list fields (window, coverage, freshness, totals, note …).

400parameter_invalid404resource_not_found429rate_limited500internal_error