Webhook

A Webhook sends HTTP POST notifications to a URL when document or recipient events occur. Webhooks belong to a User and can optionally be scoped to a specific Group.

Webhook payloads are signed with an HMAC secret available on the User type (webhookHmacSecret).

Fields

Field	Type	Description
id	ID!	Unique identifier
url	String!	Destination URL
event	WEBHOOKEVENTS	Event type to listen for
created	AWSDateTime	When the webhook was created
groupId	ID	Limit to events from a specific group
enabled	Boolean	Whether the webhook is active

WEBHOOKEVENTS

Value	Description
DOCUMENTS_ALL	All document events
DOCUMENTS_CREATED	Document created
DOCUMENTS_REJECTED	Document rejected
DOCUMENTS_COMPLETED	Document completed
RECIPIENTS_ALL	All recipient events
RECIPIENTS_EMAILED	Recipient emailed
RECIPIENTS_AUTOREMINDER	Auto-reminder sent
RECIPIENTS_EMAILBOUNCED	Email bounced
RECIPIENTS_VISITING	Recipient visiting document
RECIPIENTS_COMPLETED	Recipient completed
RECIPIENTS_REJECTED	Recipient rejected

Query

Webhooks are accessed as a field on User:

query GetMyWebhooks {
  user {
    webhooks {
      id
      url
      event
      enabled
      groupId
    }
    webhookHmacSecret
  }
}

Related

• Webhooks guide — full explanation of webhook concepts, payload schemas, verification, and debugging
• User — webhooks belong to a user
• Document — document events trigger webhooks
• Recipient — recipient events trigger webhooks