Webhooks
Introduction
The Copper Platform has a built-in webhook system to subscribe your service to specific events. This allows you to receive notifications about the events that occur in the system.
Requests are sent to the webhook URL that you specify when creating a subscription.
The webhook URL must be accessible from the internet and respond with a 200 OK
status code to confirm that the webhook was received.
Headers
Header | Description |
---|---|
X-Signature | Signature of the request |
X-Timestamp | Timestamp of the request in Unix Timestamp format (in milliseconds) |
X-Id | The identifier of the webhook subscription |
Body
event
string
requiredWebhook event type
eventId
string
requiredWebhook event id
payload
object
requiredWebhook payload
subscriptionId
string
requiredWebhook subscription id