mirror of
https://github.com/documenso/documenso.git
synced 2026-07-12 05:55:12 +10:00
Ephraim Duncan
66 lines
1.4 KiB
Plaintext
66 lines
1.4 KiB
Plaintext
---
|
|
title: Webhooks
|
|
description: Receive real-time notifications for document and template events.
|
|
---
|
|
|
|
## How Webhooks Work
|
|
|
|
1. You configure a webhook URL in Documenso
|
|
2. When an event occurs, Documenso sends an HTTP POST to your URL
|
|
3. Your application processes the event and responds with 200 OK
|
|
|
|
Documenso supports webhook events for the full document lifecycle (created, sent, opened, signed, completed, rejected, cancelled) as well as template events (created, updated, deleted, used).
|
|
|
|
---
|
|
|
|
## Getting Started
|
|
|
|
<Cards>
|
|
<Card
|
|
title="Setup"
|
|
description="Configure webhook endpoints."
|
|
href="/docs/developers/webhooks/setup"
|
|
/>
|
|
<Card
|
|
title="Events"
|
|
description="Available webhook event types."
|
|
href="/docs/developers/webhooks/events"
|
|
/>
|
|
<Card
|
|
title="Verification"
|
|
description="Verify webhook signatures for security."
|
|
href="/docs/developers/webhooks/verification"
|
|
/>
|
|
</Cards>
|
|
|
|
---
|
|
|
|
## Example Payload
|
|
|
|
```json
|
|
{
|
|
"event": "DOCUMENT_COMPLETED",
|
|
"payload": {
|
|
"id": 123,
|
|
"title": "Contract",
|
|
"status": "COMPLETED",
|
|
"completedAt": "2024-01-15T10:30:00.000Z",
|
|
"recipients": [
|
|
{
|
|
"id": 1,
|
|
"email": "signer@example.com",
|
|
"signingStatus": "SIGNED"
|
|
}
|
|
]
|
|
},
|
|
"createdAt": "2024-01-15T10:30:00.000Z",
|
|
"webhookEndpoint": "https://your-endpoint.com/webhook"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## See Also
|
|
|
|
- [Document Lifecycle](/docs/concepts/document-lifecycle) - Understanding document statuses
|