Developers
Outbound webhooks, deliveries and logs
GET/api/developers/deliveries
The team's webhook deliveries
Required scope: developers.read
| Parameter | In | Required |
|---|---|---|
cursor | query | no |
limit | query | no |
endpointId | query | no |
status | query | no |
event | query | no |
bash
curl "https://api.zapyflow.com.br/api/developers/deliveries" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK403— Forbidden, or the key lacks this scope
GET/api/developers/deliveries/{id}
One delivery and every attempt it made
Required scope: developers.read
| Parameter | In | Required |
|---|---|---|
id | path | yes |
bash
curl "https://api.zapyflow.com.br/api/developers/deliveries/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK404— Not found — also returned when the resource belongs to another workspace
POST/api/developers/deliveries/{id}/retry
Resend a delivery now
Required scope: developers.write
| Parameter | In | Required |
|---|---|---|
id | path | yes |
bash
curl -X POST "https://api.zapyflow.com.br/api/developers/deliveries/{id}/retry" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK404— Not found — also returned when the resource belongs to another workspace409— Conflict with the current state
GET/api/developers/events
Catalog of the events the platform emits
Required scope: developers.read
bash
curl "https://api.zapyflow.com.br/api/developers/events" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK
GET/api/developers/logs
List the team's event logs
Required scope: developers.read
| Parameter | In | Required |
|---|---|---|
page | query | no |
limit | query | no |
event | query | no |
source | query | no |
dateFrom | query | no |
dateTo | query | no |
webhookId | query | no |
bash
curl "https://api.zapyflow.com.br/api/developers/logs" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK403— Forbidden, or the key lacks this scope
GET/api/developers/logs/{id}
One event log in detail
Required scope: developers.read
| Parameter | In | Required |
|---|---|---|
id | path | yes |
bash
curl "https://api.zapyflow.com.br/api/developers/logs/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK403— Forbidden, or the key lacks this scope404— Not found — also returned when the resource belongs to another workspace
GET/api/developers/stats
Stats for the developers area
Required scope: developers.read
bash
curl "https://api.zapyflow.com.br/api/developers/stats" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK403— Forbidden, or the key lacks this scope
GET/api/developers/webhooks
List the team's webhook endpoints
Required scope: developers.read
bash
curl "https://api.zapyflow.com.br/api/developers/webhooks" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK403— Forbidden, or the key lacks this scope
POST/api/developers/webhooks
Create a webhook endpoint
Required scope: developers.write
Request body
| Field | Type | Required | Constraints |
|---|---|---|---|
url | string | yes | — |
events | "message.received" | "message.sent" | "message.status" | "conversation.created" | "conversation.status.changed" | "conversation.resolved" | "conversation.escalated" | "lead.captured" | "order.created" | "order.updated" | "order.deleted" | "appointment.created" | "appointment.updated" | "appointment.deleted" | "crm.card.created" | "crm.card.moved" | "crm.card.updated" | "crm.card.deleted" | "bot.created" | "bot.deleted" | "channel.connected" | "catalog.synced" | "quota.warning" | "quota.exceeded" | "trial.started" | "trial.locked" | "payment.succeeded" | "payment.failed"[] | yes | ≥ 1 items |
description | string | no | max 255 |
bash
curl -X POST "https://api.zapyflow.com.br/api/developers/webhooks" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Responses
201— Created403— Forbidden, or the key lacks this scope
PATCH/api/developers/webhooks/{id}
Update a webhook endpoint
Required scope: developers.write
| Parameter | In | Required |
|---|---|---|
id | path | yes |
Request body
| Field | Type | Required | Constraints |
|---|---|---|---|
url | string | no | — |
events | "message.received" | "message.sent" | "message.status" | "conversation.created" | "conversation.status.changed" | "conversation.resolved" | "conversation.escalated" | "lead.captured" | "order.created" | "order.updated" | "order.deleted" | "appointment.created" | "appointment.updated" | "appointment.deleted" | "crm.card.created" | "crm.card.moved" | "crm.card.updated" | "crm.card.deleted" | "bot.created" | "bot.deleted" | "channel.connected" | "catalog.synced" | "quota.warning" | "quota.exceeded" | "trial.started" | "trial.locked" | "payment.succeeded" | "payment.failed"[] | no | — |
description | string | no | max 255 |
active | boolean | no | — |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/developers/webhooks/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Responses
200— OK404— Not found — also returned when the resource belongs to another workspace
DELETE/api/developers/webhooks/{id}
Delete a webhook endpoint
Required scope: developers.write
| Parameter | In | Required |
|---|---|---|
id | path | yes |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/developers/webhooks/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK404— Not found — also returned when the resource belongs to another workspace
POST/api/developers/webhooks/{id}/test
Send a test event to a webhook
Required scope: developers.write
| Parameter | In | Required |
|---|---|---|
id | path | yes |
bash
curl -X POST "https://api.zapyflow.com.br/api/developers/webhooks/{id}/test" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK404— Not found — also returned when the resource belongs to another workspace