Rize.io webhooks allow external systems to receive real-time notifications when specific events occur. When an event is triggered, Rize.io sends an HTTP POST request to the configured webhook URL with event details.
Field | Description |
---|---|
Label | A name for the webhook. |
URL | The endpoint that will receive webhook events. |
Secret | Used to generate a signature for request verification. |
Actions | The events that will trigger the webhook. |
POST
Each webhook request includes the following headers:
{
"Content-Type": "application/json",
"X-Webhook-Event": "<event_name>",
"X-Webhook-Signature": "sha256=<hmac_signature>"
}
X-Webhook-Event
: Identifies the event that triggered the webhook.X-Webhook-Signature
: A SHA256 HMAC signature of the request body, prefixed with sha256=
, using the secret provided during webhook setup.The request body contains a JSON object with details about the triggered event. The structure varies based on the event type.
Example for project_created
event:
{
"event_type": "projected_created",
"data": {
"id": "12345",
"name": "New Project",
"client": {
id: "67890",
name: "Acme Corp"
},
"created_at": "2025-03-10T12:00:00Z"
}
}