Create Webhook

A webhook endpoint must have a url and a list of enabled eventTypes.

You can also set up webhook endpoints in the Dashboard from Settings > Webhooks.

To get started with receiving and verifying events, follow the webhooks guide.

The webhook signing secret is returned in the create response and can also be found in the Dashboard. Store it securely and use it to verify incoming webhook signatures.

Endpoint

POSThttps://api.pdfgate.com/webhook

Examples

CURL
NODE.JS
PYTHON
GO
PHP
JAVA
C#
RUBY
copy-integration-source-code-icon

Request body

url string required
The URL of the webhook endpoint.
description string
Optional description for identifying the webhook.
eventTypes array of strings required
List of event types to subscribe to. See Webhook Events for the supported events.
envelope.completedenvelope.sentenvelope.expiredenvelope.document.completed

Available responses