Create a Webhook

POST /webhooks

Create a new webhook. Use the webhook ID in subsequent requests.

Request

application/json

Body

POST /webhooks request body

url urlrequired

The URL which will receive the webhook notifications. Must be HTTPS

name string

The name of the webhook. If omitted, a name will be automatically generated. The name is only to help you identify the webhook in responses.

status string

Possible values: [active, inactive]

Default value: inactive

The status of the webhook. Only active webhooks receive notifications.

type string

Possible values: [production, development]

Default value: production

The type of the webhook. If set to development, the webhooks will only be notified of agreements with test_mode set to true.

scope object

The scope of the webhook. If set to global, the webhook will be notified of all events for all agreements created by any user associated with the account. If set to user or client, the webhook will only be notified of agreements created by the associated user/client. Note: A global webhook will always use the latest api version and could introduce unexpected data into your integration. Client/User scoped webhooks will only send data supported up to the api version specificed in your accounts.

oneOf

MOD1
MOD2
MOD3

string

subscriptions string[]

Possible values: [agreement.draft.created, agreement.draft.updated, agreement.lifecycle.pending, agreement.lifecycle.fulfilled, agreement.lifecycle.finalized, agreement.lifecycle.cancelled, agreement.lifecycle.opened, agreement.lifecycle.forwarded, agreement.validation.started, agreement.validation.completed, agreement.validation.failed, agreement.generation.restarted, agreement.generation.started, agreement.generation.completed, agreement.generation.failed, agreement.audit_trail_verification.started, agreement.audit_trail_verification.completed, agreement.audit_trail_verification.failed, agreement.pdf_verification.started, agreement.pdf_verification.completed, agreement.pdf_verification.failed, participant.draft.created, participant.draft.updated, participant.identity_enforcement.passed, participant.identity_enforcement.failed, participant.lifecycle.received_invitation, participant.lifecycle.fulfilled, sign_event.signing_room.entered, sign_event.signing_room.left, sign_event.sign.initiated_sign, sign_event.sign.cancelled_sign, sign_event.sign.completed_sign, sign_event.sign.requested_otp, sign_event.sign.received_otp, sign_event.sign.failed_to_receive_otp, sign_event.sign.confirm_otp_failed, sign_event.sign.confirmed_otp, sign_event.sign.changed_email_for_otp, sign_event.sign.forwarded_link, sign_event.approval.approved, sign_event.approval.disapproved, sign_event.document.began_scroll, sign_event.document.scrolled_to_bottom, sign_event.document.clicked_to_view, sign_event.document.loaded, sign_event.document.failed_to_load, sign_event.document.downloaded, sign_event.error.reset, email_event.agreement_invitation.delivery_failed, email_event.agreement_invitation.delivered, email_event.agreement_invitation.all_delivered, email_event.agreement_reminder.delivery_failed, email_event.agreement_reminder.delivered, email_event.agreement_reminder.all_delivered, email_event.agreement_forwarded.delivery_failed, email_event.agreement_forwarded.delivered, email_event.agreement_forwarded.all_delivered, email_event.agreement_finalized.delivery_failed, email_event.agreement_finalized.delivered, email_event.agreement_finalized.all_delivered, email_event.agreement_cancelled.delivery_failed, email_event.agreement_cancelled.delivered, email_event.agreement_cancelled.all_delivered, email_event.agreement_paused.delivery_failed, email_event.agreement_paused.delivered, email_event.agreement_paused.all_delivered]

Default value: ``

The events to subscribe to

Responses

POST /webhooks Successful response

application/json

Schema
Example (from schema)

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the webhook resource.

resource_type stringrequired

Possible values: [webhook]

Data contains the webhook resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the webhook endpoint

name string

The name of the webhook. This is only used to help you identify the webhook.

resource_type stringrequired

Possible values: [webhook]

url urlrequired

The URL of the webhook endpoint. Must be HTTPS.

secret stringrequired

The webhook secret. This is used tfor the HMAC signature of the webhook request, which is included in a header called x-zigned-request-signature

type stringrequired

Possible values: [production, development]

The type of the webhook endpoint. Development webhooks will only receive events from agreements with test_mode set to true.

scope object required

The scope of the webhook notifications. If set to user, only events related to the agreements created by the scoped user will be sent. If set to global, all events will be sent.

oneOf

MOD1
MOD2

type stringrequired

Possible values: [user]

user_id cuidrequired

The unique identifier of the user

type stringrequired

Possible values: [global]

status stringrequired

Possible values: [active, inactive]

The status of the webhook. Only active webhooks will receive notifications.

subscriptions string[]required

The events that the webhook is subscribed to.

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

{
  "version": "1.0",
  "result_type": "single",
  "resource_type": "webhook",
  "data": {
    "id": "cmo4yu6knn1cs2mrrpcexample",
    "name": "My webhook endpoint",
    "resource_type": "webhook",
    "url": "https://www.example.com",
    "secret": "string",
    "type": "production",
    "scope": {},
    "status": "active",
    "subscriptions": [
      "agreement.draft.created"
    ],
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}

POST /webhooks Error response

application/json

Schema
Example (from schema)

Schema

status stringrequired

Possible values: [error]

error objectrequired

code int64required

Possible values: >= 400 and <= 599

message stringrequired

request_id uuidrequired

{
  "status": "error",
  "error": {
    "code": 0,
    "message": "string",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Create a Webhook

/webhooks

Request​

Body

Responses​

Request

Responses