Skip to content

Add new Signatures webhook event information #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
haysch merged 2 commits into from
Apr 16, 2026
Merged

Add new Signatures webhook event information #314

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f646895
Replace `[]` with `{}` for variable declaration
haysch Apr 16, 2026
6a6099e
Add new Signatures webhook event information
haysch Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 29 additions & 16 deletions src/pages/signatures/webhooks/events.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ Triggered when a signatory successfully signs the order.
```text
{
"event" = "SIGNATORY_SIGNED",
"signatureOrderId" = "[GraphQL ID]",
"signatoryId" = "[GraphQL ID]"
"signatureOrderId" = "{SignatureOrderId}",
"signatoryId" = "{SignatoryId}"
}
```

Expand All @@ -90,9 +90,9 @@ Triggered when a signatory rejects the signature order via the UI.
```text
{
"event" = "SIGNATORY_REJECTED",
"signatureOrderId" = "[GraphQL ID]",
"signatoryId" = "[GraphQL ID]",
"reason" = "[REASON]" | null
"signatureOrderId" = "{SignatureOrderId}",
"signatoryId" = "{SignatoryId}",
"reason" = "{REASON}" | null
}
```

Expand All @@ -103,9 +103,9 @@ Triggered when a signatory experiences an error as part of signing.
```text
{
"event" = "SIGNATORY_SIGN_ERROR",
"error" = "[ERROR MESSAGE]",
"signatureOrderId" = "[GraphQL ID]",
"signatoryId" = "[GraphQL ID]"
"error" = "{ERROR MESSAGE}",
"signatureOrderId" = "{SignatureOrderId}",
"signatoryId" = "{SignatoryId}"
}
```

Expand All @@ -116,8 +116,8 @@ Triggered when a signatory opens the sign link `href`
```text
{
"event" = "SIGNATORY_SIGN_LINK_OPENED",
"signatureOrderId" = "[GraphQL ID]",
"signatoryId" = "[GraphQL ID]"
"signatureOrderId" = "{SignatureOrderId}",
"signatoryId" = "{SignatoryId}"
}
```

Expand All @@ -128,8 +128,8 @@ Triggered when a signatory opens the download link `downloadHref`
```text
{
"event" = "SIGNATORY_DOWNLOAD_LINK_OPENED",
"signatureOrderId" = "[GraphQL ID]",
"signatoryId" = "[GraphQL ID]"
"signatureOrderId" = "{SignatureOrderId}",
"signatoryId" = "{SignatoryId}"
}
```

Expand All @@ -140,9 +140,9 @@ Triggered when a signatory opens, approves or rejects a document.
```text
{
"event" = "SIGNATORY_DOCUMENT_STATUS_CHANGED",
"signatureOrderId" = "[GraphQL ID]",
"signatoryId" = "[GraphQL ID]",
"documentId" = "[GraphQL ID]",
"signatureOrderId" = "{SignatureOrderId}",
"signatoryId" = "{SignatoryId}",
"documentId" = "{DocumentId}",
"status" = "OPENED|APPROVED|REJECTED|%future%"
}
```
Expand All @@ -154,7 +154,20 @@ Triggered when a signature order has expired and is cleaned up.
```text
{
"event" = "SIGNATURE_ORDER_EXPIRED",
"signatureOrderId" = "[GraphQL ID]"
"signatureOrderId" = "{SignatureOrderId}"
}
```

## ALL_CURRENT_SIGNATORIES_SIGNED

Triggered when all current signatories have signed.
Please note, if more signatories are added, this event will arrive multiple times with a different list of signatories.

```text
{
"event" = "ALL_CURRENT_SIGNATORIES_SIGNED",
"signatoryIds" = [ "{SignatoryId}", ..."{SignatoryId}" ],
"signatureOrderId" = "{SignatureOrderId}"
}
```

Expand Down
Loading