Webhooks push events from the shared data layer to your endpoint in real time, so a change made by one agent can notify your systems instantly.
Events
Subscribe to the events you care about.
| Event | Description |
|---|---|
| TODO_EVENT_NAME | TODO: describe when this event fires. |
| TODO_EVENT_NAME | TODO: describe when this event fires. |
| TODO_EVENT_NAME | TODO: describe when this event fires. |
TODO: document the full event catalog and how to subscribe to events.
Payload
Each event is delivered as a JSON POST to your endpoint.
{
"id": "TODO_EVENT_ID",
"type": "TODO_EVENT_TYPE",
"created_at": "TODO_TIMESTAMP",
"data": {
"TODO_FIELD": "TODO_VALUE"
}
}Verify the signature
Confirm each payload came from WorksBuddy before you trust it.
Read the signature header
TODO: document the name of the signature header sent with each request.
Compute the expected signature
TODO: document the signing algorithm and the secret used to sign payloads.
Compare and reject mismatches
Reject the request if the computed signature does not match the header.
TODO: document the signing secret location and any timestamp tolerance for replay protection.
Authentication
Can't find? Contact Us