# Webhooks

A way to get notified about order state changes.

# Get existing webhooks

GET /webhooks
200 Existing webhooks fetched successfully
401 Unauthorized. The API Key is invalid or disabled.
429 Rate limit exceeded

# Create a new webhook

POST /webhooks
Request Body Schema
200 A webhook created successfully
400 Bad Request
401 Unauthorized. The API Key is invalid or disabled.
429 Rate limit exceeded

# Get an existing webhook

GET /webhooks/{id}
Path parameters
200 Existing webhook fetched successfully
401 Unauthorized. The API Key is invalid or disabled.
404 The webhook does not exist
429 Rate limit exceeded

# Update an existing webhook

PUT /webhooks/{id}
Path parameters
Request Body Schema
200 Existing webhook updated successfully
400 Bad Request
401 Unauthorized. The API Key is invalid or disabled.
404 The webhook does not exist
429 Rate limit exceeded

# Delete an existing webhook

DELETE /webhooks/{id}
Path parameters
200 Existing webhook deleted successfully
401 Unauthorized. The API Key is invalid or disabled.
404 The webhook does not exist
429 Rate limit exceeded

# Rotate a secret of an existing webhook.

The existing secret will be invalidated immediately and subsequent webhook payloads will be accompanied by HMACs using the new secret.

PUT /webhooks/{id}/rotate-secret
Path parameters
200 The secret was rotated successfully
401 Unauthorized. The API Key is invalid or disabled.
404 The webhook does not exist
429 Rate limit exceeded