Webhooks
The vendor's endpoints with their last delivery status.
Requires the webhooks:read scope.
apiKey webhooks:readAuthorizationBearer <token>An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....
Scope: webhooks:read
Success
application/json- response
data*array<>curl -X GET "https://example.com/api/v1/key/webhooks"{ "data": [ { "createdAt": "string", "description": "string", "id": "string", "url": "string", "events": [ "request.created" ], "secret": "string", "enabled": true, "lastStatus": "pending" } ]}Adds an endpoint for request.created, request.updated, product.published or product.unpublished. The response carries the signing secret once.
Requires the webhooks:write scope.
apiKey webhooks:writeAuthorizationBearer <token>An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....
Scope: webhooks:write
application/json- body
url*stringlength <= 1024events*array<>1 <= lengthdescription?string|nullenabled?booleanSuccess
application/json- response
data*curl -X POST "https://example.com/api/v1/key/webhooks" \ -H "Content-Type: application/json" \ -d '{ "url": "string", "events": [ "request.created" ] }'{ "data": { "createdAt": "string", "description": "string", "id": "string", "url": "string", "events": [ "request.created" ], "secret": "string", "enabled": true, "lastStatus": "pending" }}One endpoint.
Requires the webhooks:read scope.
apiKey webhooks:readAuthorizationBearer <token>An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....
Scope: webhooks:read
id*stringSuccess
application/json- response
data*curl -X GET "https://example.com/api/v1/key/webhooks/string"{ "data": { "createdAt": "string", "description": "string", "id": "string", "url": "string", "events": [ "request.created" ], "secret": "string", "enabled": true, "lastStatus": "pending" }}Removes an endpoint and its delivery log.
Requires the webhooks:write scope.
apiKey webhooks:writeAuthorizationBearer <token>An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....
Scope: webhooks:write
id*stringNo content
curl -X DELETE "https://example.com/api/v1/key/webhooks/string"Changes the URL, events or enabled flag.
Requires the webhooks:write scope.
apiKey webhooks:writeAuthorizationBearer <token>An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....
Scope: webhooks:write
id*stringapplication/json- body
url?stringlength <= 1024events?array<>1 <= lengthdescription?string|nullenabled?booleanSuccess
application/json- response
data*curl -X PUT "https://example.com/api/v1/key/webhooks/string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "createdAt": "string", "description": "string", "id": "string", "url": "string", "events": [ "request.created" ], "secret": "string", "enabled": true, "lastStatus": "pending" }}The delivery log of an endpoint.
Requires the webhooks:read scope.
apiKey webhooks:readAuthorizationBearer <token>An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....
Scope: webhooks:read
id*stringpage?integer1 <= valueperPage?integer1 <= value <= 50Success
application/json- response
data*array<>metadata*curl -X GET "https://example.com/api/v1/key/webhooks/string/deliveries"{ "data": [ { "createdAt": "string", "id": "string", "status": "pending", "payload": {}, "attempts": 0, "deliveredAt": "string", "durationMs": 0, "error": "string", "event": "string", "responseBody": "string", "responseStatus": 0 } ], "metadata": { "total": 0, "perPage": 0, "currentPage": 0, "lastPage": 0, "firstPage": 0, "firstPageUrl": "string", "lastPageUrl": "string", "nextPageUrl": "string", "previousPageUrl": "string" }}Re-sends a failed delivery.
Requires the webhooks:write scope.
apiKey webhooks:writeAuthorizationBearer <token>An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....
Scope: webhooks:write
id*stringdeliveryId*stringSuccess
application/json- response
data*curl -X POST "https://example.com/api/v1/key/webhooks/string/deliveries/string/retry"{ "data": { "createdAt": "string", "id": "string", "status": "pending", "payload": {}, "attempts": 0, "deliveredAt": "string", "durationMs": 0, "error": "string", "event": "string", "responseBody": "string", "responseStatus": 0 }}Issues a new signing secret, shown once.
Requires the webhooks:write scope.
apiKey webhooks:writeAuthorizationBearer <token>An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....
Scope: webhooks:write
id*stringSuccess
application/json- response
data*curl -X POST "https://example.com/api/v1/key/webhooks/string/rotate-secret"{ "data": { "createdAt": "string", "description": "string", "id": "string", "url": "string", "events": [ "request.created" ], "secret": "string", "enabled": true, "lastStatus": "pending" }}Queues a test event to the endpoint.
Requires the webhooks:write scope.
apiKey webhooks:writeAuthorizationBearer <token>An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....
Scope: webhooks:write
id*stringSuccess
application/json- response
data*curl -X POST "https://example.com/api/v1/key/webhooks/string/test"{ "data": { "createdAt": "string", "id": "string", "status": "pending", "payload": {}, "attempts": 0, "deliveredAt": "string", "durationMs": 0, "error": "string", "event": "string", "responseBody": "string", "responseStatus": 0 }}