Skip to main content
POST
Register a webhook endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-workspace-id
string

One of the workspaces the key was issued for, as returned by GET /api/v1/workspaces. Required on a key that acts for members. On any other key it is optional and omitting it acts in the key's default workspace. Any id outside the key's workspaces is rejected with 401.

x-act-as
string

Required on a key that acts for members, refused on any other key. Names the member the call runs as, as key=value: email=jane@acme.com, employee_id=E-1001, scim_external_id=… or a custom identifier. Keys are lowercase and matched case-insensitively. The call fails with 403 when no active member of the workspace matches.

Body

application/json
url
string<uri>
required

HTTPS URL to POST events to. Rejected when it is not HTTPS or its host is localhost, a .local/.internal name, or a private, loopback, link-local or multicast address. Redirects are not followed at delivery time.

Example:

"https://hooks.example.co.nz/flowsign"

events
enum<string>[]
required

Events to subscribe to. At least one.

Minimum array length: 1

Event name. PACKAGE_SENT: a package was sent to its recipients. PACKAGE_COMPLETED: every recipient finished and the package is complete. PACKAGE_VOIDED: the sender voided the package. PACKAGE_EXPIRED: the package passed its expiry before completing. PACKAGE_DECLINED: a recipient declined and the package stopped. PACKAGE_ON_HOLD: the sender paused signing on the package. PACKAGE_RESUMED: a package on hold went back out for signing. PACKAGE_SCHEDULED: the package was scheduled to send later, or moved to a new time. PACKAGE_DELETED: a package that was scheduled or out for signing was deleted. SESSION_SENT: one recipient's signing invitation was sent. SESSION_OPENED: a recipient opened their signing link. SESSION_COMPLETED: a recipient finished their step. SESSION_DECLINED: a recipient declined their step. SESSION_REMINDED: a recipient was sent a reminder. SESSION_CANCELLED: a recipient's open signing session ended because the package was declined, voided, expired or deleted, or a correction removed them.

Available options:
PACKAGE_SENT,
PACKAGE_COMPLETED,
PACKAGE_VOIDED,
PACKAGE_EXPIRED,
PACKAGE_DECLINED,
PACKAGE_ON_HOLD,
PACKAGE_RESUMED,
PACKAGE_SCHEDULED,
PACKAGE_DELETED,
SESSION_SENT,
SESSION_OPENED,
SESSION_COMPLETED,
SESSION_DECLINED,
SESSION_REMINDED,
SESSION_CANCELLED
Example:
description
string

Free-text label for the endpoint.

Example:

"Production CRM sync"

enabled
boolean

Whether to start delivering straight away. Defaults to true.

Example:

true

Response

Success

data
object
required