API reference
Webhooks
Endpoints Anyrow posts batch events to, signed with your secret.
The Webhook objectLink to section
created_atintegerRequiredAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequirednamestringRequirednullableorganization_idstringRequiredurlstringRequiredsecret_rotated_atintegerRequirednullableactivebooleanRequired
{ "created_at": 1711468800000, "updated_at": 1711468800000, "id": "whook_01h5a3g8k9m2n4p6q8r0t2v4x6", "name": "string", "organization_id": "string", "url": "https://example.com", "secret_rotated_at": 1711468800000, "active": true, "failure_count": 42, "last_triggered_at": 1711468800000, "events": [ "batch.complete" ]}List webhooks
GET/v1/organizations/{organization_id}/webhooks
Requireswebhooks:manage
Path parameters
organization_idstringRequired
Query parameters
cursorstringoptionalOpaque cursor for forward pagination. Pass the nextCursor from the previous response with the same order. Takes precedence over page when both are sent.
Up to 8192 characters.
orderstringoptionalSort keys, comma-separated, each
field[.asc|.desc][.nullsfirst|.nullslast]; at most 3. Sortable: created_at, active. Default: created_at.desc. Nulls sort last ascending and first descending unless stated.- Matches
^(?:created_at|active)(?:\.(?:asc|desc))?(?:\.(?:nullsfirst|nullslast))?(?:,(?:created_at|active)(?:\.(?:asc|desc))?(?:\.(?:nullsfirst|nullslast))?){0,2}$
Up to 200 characters.
filterstringoptionalFilter expression
field.op.value;,joins conditions with AND; group withor(...)andand(...). Fields: active (boolean: eq, ne, neq, is); created_at (number: eq, ne, neq, gt, gte, lt, lte, in, nin, is); id (string: eq, ne, neq, like, ilike, in, nin, is); name (string: eq, ne, neq, like, ilike, in, nin, is).likeis case-sensitive andilikeignores ASCII case;*is the wildcard.in/nintake(a,b);istakesnullornotnull, andtrueorfalseon a boolean. At most 20 conditions, 3 nested groups, 50 in/nin values per list, 60 values in all, 50 bytes in a like or ilike pattern once escaped, and at most 4608 bytes however a URL or a form encodes it.Up to 2048 characters.
qstringoptionalFree-text search over: name, url. Whitespace-separated terms must all match; at most 8 terms, and at most 600 bytes however a URL or a form encodes it.
Up to 200 characters.
limitintegeroptionalMaximum number of items per page, in decimal digits. Defaults to 20, capped by the endpoint's maxLimit.
- Default
20
Between 1 and 100.
pageintegeroptional1-based page number for offset pagination, up to the endpoint's maxPage (x-comb); page further by cursor. A page that is no whole number from 1, in decimal digits, is a 400 invalid_page, and one past maxPage a 400 page_too_deep, with or without a cursor. Ignored when cursor is present.
Between 1 and 10000.
Returns
200application/json
countintegerRequirednullableAt least 0.
hasMorebooleanRequiredlimitintegerRequiredAt least 1.
nextCursorstringRequirednullablepageintegerRequirednullableAt least 1.
webhooksarray of objectsRequiredcreated_atintegerRequiredAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequirednamestringRequirednullableorganization_idstringRequiredurlstringRequiredsecret_rotated_atintegerRequirednullableactivebooleanRequiredfailure_countintegerRequiredlast_triggered_atintegerRequirednullableeventsarray of stringsRequiredAt least 1 items.
Errors
- 404
not_found - 500
captcha_unavailableinternal_server_error - 502
bad_gatewayemail_send_failed
curl 'https://api.anyrow.ai/v1/organizations/{organization_id}/webhooks' \ -H 'Authorization: ApiKey {your_api_key}'{ "count": 0, "hasMore": true, "limit": 1, "nextCursor": "string", "page": 1, "webhooks": [ { "created_at": 1711468800000, "updated_at": 1711468800000, "id": "whook_01h5a3g8k9m2n4p6q8r0t2v4x6", "name": "string", "organization_id": "string", "url": "https://example.com", "secret_rotated_at": 1711468800000, "active": true, "failure_count": 42, "last_triggered_at": 1711468800000, "events": [ "batch.complete" ] } ]}Create webhook
POST/v1/organizations/{organization_id}/webhooks
Requireswebhooks:manage
Path parameters
organization_idstringRequired
Request body
application/json
eventsarray of stringsRequiredAt least 1 items.
namestringoptionalUp to 64 characters.
urlstringRequired- Matches
^https:\/\/
Up to 2048 characters.
Returns
201application/json
created_atintegerRequiredAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequirednamestringRequirednullableorganization_idstringRequiredurlstringRequiredsecret_rotated_atintegerRequirednullableactivebooleanRequiredfailure_countintegerRequiredlast_triggered_atintegerRequirednullableeventsarray of stringsRequiredAt least 1 items.
secretstringRequired
Errors
- 404
not_found - 500
captcha_unavailableinternal_server_errorwebhook_create_failed - 502
bad_gatewayemail_send_failed
curl -X POST 'https://api.anyrow.ai/v1/organizations/{organization_id}/webhooks' \ -H 'Authorization: ApiKey {your_api_key}' \ -H 'Content-Type: application/json' \ -d '{ "events": [ "batch.complete" ], "name": "string", "url": "string"}'{ "created_at": 1711468800000, "updated_at": 1711468800000, "id": "whook_01h5a3g8k9m2n4p6q8r0t2v4x6", "name": "string", "organization_id": "string", "url": "https://example.com", "secret_rotated_at": 1711468800000, "active": true, "failure_count": 42, "last_triggered_at": 1711468800000, "events": [ "batch.complete" ], "secret": "string"}Get webhook
GET/v1/organizations/{organization_id}/webhooks/{id}
Requireswebhooks:manage
Path parameters
organization_idstringRequiredidstringRequired
Returns
200application/json
created_atintegerRequiredAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequirednamestringRequirednullableorganization_idstringRequiredurlstringRequiredsecret_rotated_atintegerRequirednullableactivebooleanRequiredfailure_countintegerRequiredlast_triggered_atintegerRequirednullableeventsarray of stringsRequiredAt least 1 items.
Errors
- 404
not_foundwebhook_not_found - 500
captcha_unavailableinternal_server_error - 502
bad_gatewayemail_send_failed
curl 'https://api.anyrow.ai/v1/organizations/{organization_id}/webhooks/{id}' \ -H 'Authorization: ApiKey {your_api_key}'{ "created_at": 1711468800000, "updated_at": 1711468800000, "id": "whook_01h5a3g8k9m2n4p6q8r0t2v4x6", "name": "string", "organization_id": "string", "url": "https://example.com", "secret_rotated_at": 1711468800000, "active": true, "failure_count": 42, "last_triggered_at": 1711468800000, "events": [ "batch.complete" ]}Update webhook
PATCH/v1/organizations/{organization_id}/webhooks/{id}
Requireswebhooks:manage
Path parameters
organization_idstringRequiredidstringRequired
Request body
application/json
activebooleanoptionaleventsarray of stringsoptionalAt least 1 items.
namestringoptionalUp to 64 characters.
urlstringoptional- Matches
^https:\/\/
Up to 2048 characters.
Returns
200application/json
created_atintegerRequiredAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequirednamestringRequirednullableorganization_idstringRequiredurlstringRequiredsecret_rotated_atintegerRequirednullableactivebooleanRequiredfailure_countintegerRequiredlast_triggered_atintegerRequirednullableeventsarray of stringsRequiredAt least 1 items.
Errors
- 404
not_foundwebhook_not_found - 500
captcha_unavailableinternal_server_errorwebhook_update_failed - 502
bad_gatewayemail_send_failed
curl -X PATCH 'https://api.anyrow.ai/v1/organizations/{organization_id}/webhooks/{id}' \ -H 'Authorization: ApiKey {your_api_key}' \ -H 'Content-Type: application/json' \ -d '{ "active": true, "events": [ "batch.complete" ], "name": "string", "url": "string"}'{ "created_at": 1711468800000, "updated_at": 1711468800000, "id": "whook_01h5a3g8k9m2n4p6q8r0t2v4x6", "name": "string", "organization_id": "string", "url": "https://example.com", "secret_rotated_at": 1711468800000, "active": true, "failure_count": 42, "last_triggered_at": 1711468800000, "events": [ "batch.complete" ]}Delete webhook
DELETE/v1/organizations/{organization_id}/webhooks/{id}
Requireswebhooks:manage
Path parameters
organization_idstringRequiredidstringRequired
Returns
200application/json
idstringRequired
Errors
- 404
not_foundwebhook_not_found - 500
captcha_unavailableinternal_server_error - 502
bad_gatewayemail_send_failed
curl -X DELETE 'https://api.anyrow.ai/v1/organizations/{organization_id}/webhooks/{id}' \ -H 'Authorization: ApiKey {your_api_key}'{ "id": "string"}List webhook deliveries
GET/v1/organizations/{organization_id}/webhooks/{id}/deliveries
Requireswebhooks:manage
Path parameters
organization_idstringRequiredidstringRequired
Query parameters
cursorstringoptionalOpaque cursor for forward pagination. Pass the nextCursor from the previous response with the same order. Takes precedence over page when both are sent.
Up to 8192 characters.
orderstringoptionalSort keys, comma-separated, each
field[.asc|.desc][.nullsfirst|.nullslast]; at most 3. Sortable: created_at, status. Default: created_at.desc. Nulls sort last ascending and first descending unless stated.- Matches
^(?:created_at|status)(?:\.(?:asc|desc))?(?:\.(?:nullsfirst|nullslast))?(?:,(?:created_at|status)(?:\.(?:asc|desc))?(?:\.(?:nullsfirst|nullslast))?){0,2}$
Up to 200 characters.
limitintegeroptionalMaximum number of items per page, in decimal digits. Defaults to 20, capped by the endpoint's maxLimit.
- Default
20
Between 1 and 100.
pageintegeroptional1-based page number for offset pagination, up to the endpoint's maxPage (x-comb); page further by cursor. A page that is no whole number from 1, in decimal digits, is a 400 invalid_page, and one past maxPage a 400 page_too_deep, with or without a cursor. Ignored when cursor is present.
Between 1 and 10000.
eventstringoptional- Allowed values
batch.completebatch.failedbatch.partialping
statusstringoptional- Allowed values
pendingsuccessfailed
Returns
200application/json
countintegerRequirednullableAt least 0.
hasMorebooleanRequiredlimitintegerRequiredAt least 1.
nextCursorstringRequirednullablepageintegerRequirednullableAt least 1.
deliveriesarray of objectsRequiredcreated_atintegerRequiredAt least 0.
idstringRequiredwebhook_idstringRequiredeventstringRequired- Allowed values
batch.completebatch.failedbatch.partialping
payload_jsonstringRequiredstatusstringRequired- Allowed values
pendingsuccessfailed
http_statusintegerRequirednullableresponse_bodystringRequirednullableattemptintegerRequirednext_retry_atintegerRequirednullabledelivered_atintegerRequirednullable
Errors
- 404
not_foundwebhook_not_found - 500
captcha_unavailableinternal_server_error - 502
bad_gatewayemail_send_failed
curl 'https://api.anyrow.ai/v1/organizations/{organization_id}/webhooks/{id}/deliveries' \ -H 'Authorization: ApiKey {your_api_key}'{ "count": 0, "hasMore": true, "limit": 1, "nextCursor": "string", "page": 1, "deliveries": [ { "created_at": 1711468800000, "id": "whdlv_01h5a3g8k9m2n4p6q8r0t2v4x6", "webhook_id": "string", "event": "batch.complete", "payload_json": "string", "status": "pending", "http_status": 42, "response_body": "string", "attempt": 42, "next_retry_at": 1711468800000, "delivered_at": 1711468800000 } ]}Rotate webhook secret
POST/v1/organizations/{organization_id}/webhooks/{id}/rotate-secret
Requireswebhooks:manage
Path parameters
organization_idstringRequiredidstringRequired
Returns
200application/json
created_atintegerRequiredAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequirednamestringRequirednullableorganization_idstringRequiredurlstringRequiredsecret_rotated_atintegerRequirednullableactivebooleanRequiredfailure_countintegerRequiredlast_triggered_atintegerRequirednullableeventsarray of stringsRequiredAt least 1 items.
secretstringRequired
Errors
- 404
not_foundwebhook_not_found - 500
captcha_unavailableinternal_server_errorwebhook_update_failed - 502
bad_gatewayemail_send_failed
curl -X POST 'https://api.anyrow.ai/v1/organizations/{organization_id}/webhooks/{id}/rotate-secret' \ -H 'Authorization: ApiKey {your_api_key}'{ "created_at": 1711468800000, "updated_at": 1711468800000, "id": "whook_01h5a3g8k9m2n4p6q8r0t2v4x6", "name": "string", "organization_id": "string", "url": "https://example.com", "secret_rotated_at": 1711468800000, "active": true, "failure_count": 42, "last_triggered_at": 1711468800000, "events": [ "batch.complete" ], "secret": "string"}Send test webhook
POST/v1/organizations/{organization_id}/webhooks/{id}/test
Requireswebhooks:manage
Path parameters
organization_idstringRequiredidstringRequired
Returns
200application/json
http_statusnumberRequirednullableresponse_bodystringRequirednullableUp to 1024 characters.
statusstringRequired- Allowed values
errorsuccesstimeout
Errors
- 404
not_foundwebhook_not_found - 500
captcha_unavailableinternal_server_errorwebhook_test_failed - 502
bad_gatewayemail_send_failed
curl -X POST 'https://api.anyrow.ai/v1/organizations/{organization_id}/webhooks/{id}/test' \ -H 'Authorization: ApiKey {your_api_key}'{ "http_status": 0, "response_body": "string", "status": "error"}