PT EN

Programadores: Webhooks

URL base: $BUSINESS_API

Listar webhooks

Registos

GET /developer/webhooks

Returns the tenant's webhook endpoints, one cursor page at a time, with their URL, subscribed events, enabled flag and health. Signing secrets are not included. Requires developer:read.

Parâmetros

limitinteger · consulta · opcional

Maximum resources to return (default 20, maximum 100).

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

Devolve

200 Endpoints

Mostrar atributos
dataarray of DeveloperWebhook · opcional
Mostrar atributos filhos
idstring · obrigatório
urlstring (uri) · obrigatório
descriptionstring · obrigatório
eventsarray of string · obrigatório

Event types, or * for all

enabledboolean · obrigatório
created_bystring · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
previous_secret_expires_atstring (date-time) · opcional
healthstring · opcional

um de healthy, degraded, failing, paused_automatically, paused_by_owner

health_changed_atstring (date-time) · opcional
failing_sincestring (date-time) · opcional
consecutive_failuresinteger · opcional
paused_reasonstring · opcional
api_versionstring · opcional
secretstring · opcional

The signing secret; present only on the create and roll responses

has_moreboolean · opcional
next_cursorstring · opcional

Erros 400 · 401 · 403

Permissões developer:read · Funções: admin, owner

curl -X GET "$BUSINESS_API/developer/webhooks" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "data": [
    {
      "id": "dev_2waHzwg9riK13kAtNGAHfAgvB0c",
      "url": "https://example.org/",
      "description": "Leitura confirmada no local.",
      "events": [
        "event"
      ],
      "enabled": true,
      "created_by": "created by",
      "created_at": "2026-11-19T09:30:00Z",
      "updated_at": "2026-11-19T09:30:00Z",
      "previous_secret_expires_at": "2026-11-19T09:30:00Z",
      "health": "healthy",
      "health_changed_at": "2026-11-19T09:30:00Z",
      "failing_since": "2026-11-19T09:30:00Z",
      "consecutive_failures": 1,
      "paused_reason": "paused reason",
      "api_version": "api version",
      "secret": "secret"
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}

Criar um webhook

Registos

POST /developer/webhooks

Create a webhook endpoint; the signing secret appears once in the response

Registers an endpoint and returns its signing secret only in this response. The URL must be absolute https, without credentials or a fragment, at most 2048 characters, and must resolve to a public address; internal host names and private, loopback or link-local addresses are refused with 400. At least one known event type (or *) is required, description is limited to 512 characters, and enabled defaults to true. Requires developer:write.

Corpo application/json

urlstring (uri) · obrigatório

https; private, loopback and link-local targets are refused outside development

descriptionstring · opcional
eventsarray of string · obrigatório
enabledboolean · opcional · predefinição true

Devolve

201 Endpoint created; secret is shown only here

Mostrar atributos
idstring · obrigatório
urlstring (uri) · obrigatório
descriptionstring · obrigatório
eventsarray of string · obrigatório

Event types, or * for all

enabledboolean · obrigatório
created_bystring · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
previous_secret_expires_atstring (date-time) · opcional
healthstring · opcional

um de healthy, degraded, failing, paused_automatically, paused_by_owner

health_changed_atstring (date-time) · opcional
failing_sincestring (date-time) · opcional
consecutive_failuresinteger · opcional
paused_reasonstring · opcional
api_versionstring · opcional
secretstring · opcional

The signing secret; present only on the create and roll responses

Erros 400 · 401 · 403

Permissões developer:write · Funções: admin, owner

curl -X POST "$BUSINESS_API/developer/webhooks" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.org/",
  "description": "Leitura confirmada no local.",
  "events": [
    "event"
  ],
  "enabled": true
}'
Resposta 201
{
  "id": "dev_2waHzwg9riK13kAtNGAHfAgvB0c",
  "url": "https://example.org/",
  "description": "Leitura confirmada no local.",
  "events": [
    "event"
  ],
  "enabled": true,
  "created_by": "created by",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z",
  "previous_secret_expires_at": "2026-11-19T09:30:00Z",
  "health": "healthy",
  "health_changed_at": "2026-11-19T09:30:00Z",
  "failing_since": "2026-11-19T09:30:00Z",
  "consecutive_failures": 1,
  "paused_reason": "paused reason",
  "api_version": "api version",
  "secret": "secret"
}

Obter um webhook

Registos

GET /developer/webhooks/{id}

Returns one webhook endpoint with its URL, description, subscribed events, enabled flag and delivery health; the signing secret is not included. Requires developer:read; an unknown endpoint returns 404.

Parâmetros

idstring · caminho · obrigatório

Identifier of the webhook endpoint in the authenticated tenant.

Devolve

200 Endpoint

Mostrar atributos
idstring · obrigatório
urlstring (uri) · obrigatório
descriptionstring · obrigatório
eventsarray of string · obrigatório

Event types, or * for all

enabledboolean · obrigatório
created_bystring · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
previous_secret_expires_atstring (date-time) · opcional
healthstring · opcional

um de healthy, degraded, failing, paused_automatically, paused_by_owner

health_changed_atstring (date-time) · opcional
failing_sincestring (date-time) · opcional
consecutive_failuresinteger · opcional
paused_reasonstring · opcional
api_versionstring · opcional
secretstring · opcional

The signing secret; present only on the create and roll responses

Erros 400 · 401 · 403

Permissões developer:read · Funções: admin, owner

curl -X GET "$BUSINESS_API/developer/webhooks/{id}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "id": "dev_2waHzwg9riK13kAtNGAHfAgvB0c",
  "url": "https://example.org/",
  "description": "Leitura confirmada no local.",
  "events": [
    "event"
  ],
  "enabled": true,
  "created_by": "created by",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z",
  "previous_secret_expires_at": "2026-11-19T09:30:00Z",
  "health": "healthy",
  "health_changed_at": "2026-11-19T09:30:00Z",
  "failing_since": "2026-11-19T09:30:00Z",
  "consecutive_failures": 1,
  "paused_reason": "paused reason",
  "api_version": "api version",
  "secret": "secret"
}

Substituir um webhook

Registos

PUT /developer/webhooks/{id}

Served by the same handler as the PATCH operation on this path and behaves the same way: only the fields present in the body change, so omitted fields keep their current values rather than being cleared. url is checked against the same public https rules as on creation, description may hold at most 512 characters, and events must name known event types. Setting enabled to false pauses the endpoint and holds its deliveries; setting it back to true resumes them in order. Requires developer:write. Invalid fields or a refused url return 400, a missing scope returns 403 and an unknown endpoint returns 404.

Parâmetros

idstring · caminho · obrigatório

Identifier of the webhook endpoint to change, matched within the caller's tenant.

Corpo application/json

urlstring (uri) · opcional
descriptionstring · opcional
eventsarray of string · opcional
enabledboolean · opcional

Devolve

200 Endpoint after the change

Mostrar atributos
idstring · obrigatório
urlstring (uri) · obrigatório
descriptionstring · obrigatório
eventsarray of string · obrigatório

Event types, or * for all

enabledboolean · obrigatório
created_bystring · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
previous_secret_expires_atstring (date-time) · opcional
healthstring · opcional

um de healthy, degraded, failing, paused_automatically, paused_by_owner

health_changed_atstring (date-time) · opcional
failing_sincestring (date-time) · opcional
consecutive_failuresinteger · opcional
paused_reasonstring · opcional
api_versionstring · opcional
secretstring · opcional

The signing secret; present only on the create and roll responses

Erros 400 · 401 · 403 · 404

Permissões developer:write · Funções: admin, owner

curl -X PUT "$BUSINESS_API/developer/webhooks/{id}" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.org/",
  "description": "Leitura confirmada no local.",
  "events": [
    "event"
  ],
  "enabled": true
}'
Resposta 200
{
  "id": "dev_2waHzwg9riK13kAtNGAHfAgvB0c",
  "url": "https://example.org/",
  "description": "Leitura confirmada no local.",
  "events": [
    "event"
  ],
  "enabled": true,
  "created_by": "created by",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z",
  "previous_secret_expires_at": "2026-11-19T09:30:00Z",
  "health": "healthy",
  "health_changed_at": "2026-11-19T09:30:00Z",
  "failing_since": "2026-11-19T09:30:00Z",
  "consecutive_failures": 1,
  "paused_reason": "paused reason",
  "api_version": "api version",
  "secret": "secret"
}

Actualizar um webhook

Registos

PATCH /developer/webhooks/{id}

Changes only the fields supplied: url (checked against the same public https rules as on creation), description (512 characters at most), events and enabled. Setting enabled to false pauses the endpoint and holds its deliveries rather than cancelling them; setting it back to true resumes them in order. Requires developer:write; invalid fields return 400 and an unknown endpoint returns 404. The same operation is also served with PUT.

Parâmetros

idstring · caminho · obrigatório

Identifier of the webhook endpoint to change.

Corpo application/json

urlstring (uri) · opcional
descriptionstring · opcional
eventsarray of string · opcional
enabledboolean · opcional

Devolve

200 Endpoint

Mostrar atributos
idstring · obrigatório
urlstring (uri) · obrigatório
descriptionstring · obrigatório
eventsarray of string · obrigatório

Event types, or * for all

enabledboolean · obrigatório
created_bystring · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
previous_secret_expires_atstring (date-time) · opcional
healthstring · opcional

um de healthy, degraded, failing, paused_automatically, paused_by_owner

health_changed_atstring (date-time) · opcional
failing_sincestring (date-time) · opcional
consecutive_failuresinteger · opcional
paused_reasonstring · opcional
api_versionstring · opcional
secretstring · opcional

The signing secret; present only on the create and roll responses

Erros 400 · 401 · 403

Permissões developer:write · Funções: admin, owner

curl -X PATCH "$BUSINESS_API/developer/webhooks/{id}" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.org/",
  "description": "Leitura confirmada no local.",
  "events": [
    "event"
  ],
  "enabled": true
}'
Resposta 200
{
  "id": "dev_2waHzwg9riK13kAtNGAHfAgvB0c",
  "url": "https://example.org/",
  "description": "Leitura confirmada no local.",
  "events": [
    "event"
  ],
  "enabled": true,
  "created_by": "created by",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z",
  "previous_secret_expires_at": "2026-11-19T09:30:00Z",
  "health": "healthy",
  "health_changed_at": "2026-11-19T09:30:00Z",
  "failing_since": "2026-11-19T09:30:00Z",
  "consecutive_failures": 1,
  "paused_reason": "paused reason",
  "api_version": "api version",
  "secret": "secret"
}

Eliminar um webhook

Registos

DELETE /developer/webhooks/{id}

Requires the developer:write scope. The endpoint is removed permanently, and in the same transaction every delivery still pending or paused for it is marked cancelled with the reason "endpoint deleted"; deliveries already completed keep their history. Answers 204 with no body, or 404 when no endpoint with this id exists in the caller's tenant. The deletion is recorded in the audit trail.

Parâmetros

idstring · caminho · obrigatório

Identifier of the webhook endpoint to delete, matched within the caller's tenant only.

Devolve

204 Deleted

Erros 400 · 401 · 403

Permissões developer:write · Funções: admin, owner

curl -X DELETE "$BUSINESS_API/developer/webhooks/{id}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 204

Deleted

Renovar o segredo de um webhook

Registos

POST /developer/webhooks/{id}/roll

Roll a signing secret; both secrets sign during the overlap

Requires the developer:write scope. A new signing secret is generated and returned once in the secret field of the 201 response, so store it right away. The optional overlap_seconds body field sets how long the previous secret keeps signing alongside the new one, from 0 to 604800 seconds (7 days) with a default of 24 hours, and 0 retires the old secret immediately; a value out of range answers 400. Answers 404 when the endpoint does not exist in the caller's tenant.

Parâmetros

idstring · caminho · obrigatório

Identifier of the webhook endpoint whose signing secret is replaced, matched within the caller's tenant.

Corpo application/json

overlap_secondsinteger · opcional

How long the old key or secret keeps working; default 86400

Devolve

201 New secret; shown only here

Mostrar atributos
idstring · obrigatório
urlstring (uri) · obrigatório
descriptionstring · obrigatório
eventsarray of string · obrigatório

Event types, or * for all

enabledboolean · obrigatório
created_bystring · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
previous_secret_expires_atstring (date-time) · opcional
healthstring · opcional

um de healthy, degraded, failing, paused_automatically, paused_by_owner

health_changed_atstring (date-time) · opcional
failing_sincestring (date-time) · opcional
consecutive_failuresinteger · opcional
paused_reasonstring · opcional
api_versionstring · opcional
secretstring · opcional

The signing secret; present only on the create and roll responses

Erros 400 · 401 · 403

Permissões developer:write · Funções: admin, owner

curl -X POST "$BUSINESS_API/developer/webhooks/{id}/roll" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "overlap_seconds": 0
}'
Resposta 201
{
  "id": "dev_2waHzwg9riK13kAtNGAHfAgvB0c",
  "url": "https://example.org/",
  "description": "Leitura confirmada no local.",
  "events": [
    "event"
  ],
  "enabled": true,
  "created_by": "created by",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z",
  "previous_secret_expires_at": "2026-11-19T09:30:00Z",
  "health": "healthy",
  "health_changed_at": "2026-11-19T09:30:00Z",
  "failing_since": "2026-11-19T09:30:00Z",
  "consecutive_failures": 1,
  "paused_reason": "paused reason",
  "api_version": "api version",
  "secret": "secret"
}

Testar um webhook

Registos

POST /developer/webhooks/{id}/test

Requires the developer:write scope. A test event is published to this endpoint only and goes through the normal delivery queue, signing and retries; the response is 202 with the queued delivery, which you can follow through the deliveries endpoints. Answers 409 when the endpoint is disabled or paused, so enable or resume it first, and 404 when it does not exist in the caller's tenant.

Parâmetros

idstring · caminho · obrigatório

Identifier of the webhook endpoint that receives the test event, matched within the caller's tenant.

Devolve

202 Queued delivery

Mostrar atributos
idstring · opcional
webhook_idstring · opcional
urlstring · opcional
event_idstring · opcional
event_typestring · opcional
statusstring · opcional

um de pending, delivering, succeeded, failed, cancelled, paused

attemptsinteger · opcional
max_attemptsinteger · opcional
next_attempt_atstring (date-time) · opcional
response_statusinteger · opcional
last_errorstring · opcional
duration_msinteger · opcional
created_atstring (date-time) · opcional
completed_atstring (date-time) · opcional
payloadstring · opcional

JSON event body; on the detail read

historyarray of object · opcional
Mostrar atributos filhos
attemptinteger · opcional
response_statusinteger · opcional
errorstring · opcional
response_bodystring · opcional
duration_msinteger · opcional
occurred_atstring (date-time) · opcional

Erros 400 · 401 · 403

Permissões developer:write · Funções: admin, owner

curl -X POST "$BUSINESS_API/developer/webhooks/{id}/test" \
  -H "Authorization: Bearer sk_test_..."
Resposta 202
{
  "id": "dev_2xrGunF2qj9uI97qEnJQArJ0Qd5",
  "webhook_id": "whk_2Fhestrmgp5E6phyoldkw1BQmj3",
  "url": "https://example.org/",
  "event_id": "eve_2yU5ru85900HFyKpvIKdHuq7NSO",
  "event_type": "event type",
  "status": "pending",
  "attempts": 1,
  "max_attempts": 1,
  "next_attempt_at": "2026-11-19T09:30:00Z",
  "response_status": 1,
  "last_error": "last error",
  "duration_ms": 1,
  "created_at": "2026-11-19T09:30:00Z",
  "completed_at": "2026-11-19T09:30:00Z",
  "payload": "payload",
  "history": [
    {
      "attempt": 1,
      "response_status": 1,
      "error": "error",
      "response_body": "response body",
      "duration_ms": 1,
      "occurred_at": "2026-11-19T09:30:00Z"
    }
  ]
}

Retomar um webhook

Registos

POST /developer/webhooks/{id}/resume

Resume a paused endpoint; its held deliveries are sent in order

Requires the developer:write scope. The endpoint URL is checked again as a delivery target first, and a refused target answers 400 naming the url field. On success the endpoint is enabled and marked healthy, its pause reason and failure count are cleared, and every delivery held as paused is set back to pending for immediate sending; the updated endpoint is returned. Answers 404 when the endpoint does not exist in the caller's tenant.

Parâmetros

idstring · caminho · obrigatório

Identifier of the webhook endpoint to resume, matched within the caller's tenant.

Devolve

200 The resumed endpoint

Mostrar atributos
idstring · obrigatório
urlstring (uri) · obrigatório
descriptionstring · obrigatório
eventsarray of string · obrigatório

Event types, or * for all

enabledboolean · obrigatório
created_bystring · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
previous_secret_expires_atstring (date-time) · opcional
healthstring · opcional

um de healthy, degraded, failing, paused_automatically, paused_by_owner

health_changed_atstring (date-time) · opcional
failing_sincestring (date-time) · opcional
consecutive_failuresinteger · opcional
paused_reasonstring · opcional
api_versionstring · opcional
secretstring · opcional

The signing secret; present only on the create and roll responses

Erros 400 · 401 · 403 · 404

Permissões developer:write · Funções: admin, owner

curl -X POST "$BUSINESS_API/developer/webhooks/{id}/resume" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "id": "dev_2waHzwg9riK13kAtNGAHfAgvB0c",
  "url": "https://example.org/",
  "description": "Leitura confirmada no local.",
  "events": [
    "event"
  ],
  "enabled": true,
  "created_by": "created by",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z",
  "previous_secret_expires_at": "2026-11-19T09:30:00Z",
  "health": "healthy",
  "health_changed_at": "2026-11-19T09:30:00Z",
  "failing_since": "2026-11-19T09:30:00Z",
  "consecutive_failures": 1,
  "paused_reason": "paused reason",
  "api_version": "api version",
  "secret": "secret"
}

Reenviar entregas de um webhook

Registos

POST /developer/webhooks/{id}/redeliveries

Re-queue an endpoint's failed or paused deliveries in a window of at most 7 days

Deliveries are re-queued in order per resource. With dry_run the count is returned and nothing changes.

Parâmetros

idstring · caminho · obrigatório

Identifier of the webhook endpoint whose deliveries are re-queued; it must exist in the caller's tenant or the request answers 404.

Corpo application/json

fromstring (date-time) · opcional

Defaults to 24 hours before to

tostring (date-time) · opcional

Defaults to now

typesarray of string · opcional
statusesarray of string · opcional

Defaults to failed and paused

dry_runboolean · opcional

Devolve

200 Dry run count

Mostrar atributos
idstring · opcional

wrd_ identifier; empty on a dry run

webhook_idstring · opcional
fromstring (date-time) · opcional
tostring (date-time) · opcional
typesarray of string · opcional
statusesarray of string · opcional
requeuedinteger · opcional

Deliveries re-queued, or that would be on a dry run

dry_runboolean · opcional
created_bystring · opcional
created_atstring (date-time) · opcional

Erros 400 · 401 · 403 · 404

Permissões developer:write · Funções: admin, owner

curl -X POST "$BUSINESS_API/developer/webhooks/{id}/redeliveries" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "from": "2026-11-19T09:30:00Z",
  "to": "2026-11-19T09:30:00Z",
  "types": [
    "active"
  ],
  "statuses": [
    "failed"
  ],
  "dry_run": true
}'
Resposta 200
{
  "id": "dev_2sSDlsKRFIIj5ky1fUOzZg8FDiO",
  "webhook_id": "whk_2Fhestrmgp5E6phyoldkw1BQmj3",
  "from": "2026-11-19T09:30:00Z",
  "to": "2026-11-19T09:30:00Z",
  "types": [
    "active"
  ],
  "statuses": [
    "failed"
  ],
  "requeued": 1,
  "dry_run": true,
  "created_by": "created by",
  "created_at": "2026-11-19T09:30:00Z"
}

Obter um reenvio de entregas

Registos

GET /developer/webhooks/{id}/redeliveries/{redeliveryId}

Requires the developer:read scope. Returns a bulk redelivery created earlier for this endpoint: its time window, the event types and delivery statuses it selected, how many deliveries it re-queued, who created it and when. Dry runs are not stored, so they cannot be read back here. Answers 404 when the redelivery does not exist or belongs to a different endpoint.

Parâmetros

idstring · caminho · obrigatório

Identifier of the webhook endpoint the redelivery was created for, matched within the caller's tenant.

redeliveryIdstring · caminho · obrigatório

Identifier of the redelivery, as returned when it was created; it is only found under the endpoint it was created for.

Devolve

200 The redelivery

Mostrar atributos
idstring · opcional

wrd_ identifier; empty on a dry run

webhook_idstring · opcional
fromstring (date-time) · opcional
tostring (date-time) · opcional
typesarray of string · opcional
statusesarray of string · opcional
requeuedinteger · opcional

Deliveries re-queued, or that would be on a dry run

dry_runboolean · opcional
created_bystring · opcional
created_atstring (date-time) · opcional

Erros 401 · 403 · 404

Permissões developer:read · Funções: admin, owner

curl -X GET "$BUSINESS_API/developer/webhooks/{id}/redeliveries/{redeliveryId}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "id": "dev_2sSDlsKRFIIj5ky1fUOzZg8FDiO",
  "webhook_id": "whk_2Fhestrmgp5E6phyoldkw1BQmj3",
  "from": "2026-11-19T09:30:00Z",
  "to": "2026-11-19T09:30:00Z",
  "types": [
    "active"
  ],
  "statuses": [
    "failed"
  ],
  "requeued": 1,
  "dry_run": true,
  "created_by": "created by",
  "created_at": "2026-11-19T09:30:00Z"
}

Listar entregas de um webhook

Registos

GET /developer/webhooks/{id}/deliveries

Requires the developer:read scope. Returns one page of this endpoint's deliveries ordered by creation time, using the limit and after cursor parameters, and the status query parameter narrows the list to deliveries in exactly that state. Answers 404 when the endpoint does not exist in the caller's tenant; to see a delivery's payload and attempt history, read it by its own id.

Parâmetros

idstring · caminho · obrigatório

Identifier of the webhook endpoint whose deliveries are listed; it must exist in the caller's tenant or the request answers 404.

statusstring · consulta · opcional

pending, delivering, succeeded, failed or cancelled

limitinteger · consulta · opcional

Maximum resources to return (default 20, maximum 100).

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

Devolve

200 Deliveries

Mostrar atributos
dataarray of DeveloperDelivery · opcional
Mostrar atributos filhos
idstring · opcional
webhook_idstring · opcional
urlstring · opcional
event_idstring · opcional
event_typestring · opcional
statusstring · opcional

um de pending, delivering, succeeded, failed, cancelled, paused

attemptsinteger · opcional
max_attemptsinteger · opcional
next_attempt_atstring (date-time) · opcional
response_statusinteger · opcional
last_errorstring · opcional
duration_msinteger · opcional
created_atstring (date-time) · opcional
completed_atstring (date-time) · opcional
payloadstring · opcional

JSON event body; on the detail read

historyarray of object · opcional
Mostrar atributos filhos
attemptinteger · opcional
response_statusinteger · opcional
errorstring · opcional
response_bodystring · opcional
duration_msinteger · opcional
occurred_atstring (date-time) · opcional
has_moreboolean · opcional
next_cursorstring · opcional

Erros 400 · 401 · 403

Permissões developer:read · Funções: admin, owner

curl -X GET "$BUSINESS_API/developer/webhooks/{id}/deliveries" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "data": [
    {
      "id": "dev_2xrGunF2qj9uI97qEnJQArJ0Qd5",
      "webhook_id": "whk_2Fhestrmgp5E6phyoldkw1BQmj3",
      "url": "https://example.org/",
      "event_id": "eve_2yU5ru85900HFyKpvIKdHuq7NSO",
      "event_type": "event type",
      "status": "pending",
      "attempts": 1,
      "max_attempts": 1,
      "next_attempt_at": "2026-11-19T09:30:00Z",
      "response_status": 1,
      "last_error": "last error",
      "duration_ms": 1,
      "created_at": "2026-11-19T09:30:00Z",
      "completed_at": "2026-11-19T09:30:00Z",
      "payload": "payload",
      "history": [
        {
          "attempt": 1,
          "response_status": 1,
          "error": "error",
          "response_body": "response body",
          "duration_ms": 1,
          "occurred_at": "2026-11-19T09:30:00Z"
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}