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.

POST https://your-domain.com/webhook/path

Headers

HeaderDescription
X-SignatureSignature of the request
X-TimestampTimestamp of the request in Unix Timestamp format (in milliseconds)
X-IdThe identifier of the webhook subscription

Body

event
string
required

Webhook event type

eventId
string
required

Webhook event id

payload
object
required

Webhook payload

subscriptionId
string
required

Webhook subscription id