/rest/webhooks (GET, POST, PATCH, DELETE). You need the API keys and webhooks permission.
Events
Event names are<object>.<action>:
Wildcards:
*.created, company.*, *.*. For example opportunity.updated or dealReview.created.
Payload
userId, apiKeyId, workspaceMemberId and applicationId say who made the change, when known.
Verify signatures
Give the webhook a secret. Each delivery then carries:Delivery
- Hermios waits up to 5 seconds for your endpoint. Answer
2xxquickly and do the work in the background. - A delivery that fails or times out is not retried. If you cannot miss an event, reconcile periodically with the REST API (for example
order_by=updatedAt[DescNullsLast]). - Deliveries can arrive out of order. Use
eventDateand the record’supdatedAt.