List Webhooks

GET 
/webhooks

Lists all webhooks created for the account.

Request

Responses

200

GET /webhooks Successful response

application/json

Schema

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [list]

A non-paginated list of the webhook resource.

resource_type stringrequired

Possible values: [webhook]

Data contains the webhook resource.

data object[]required
Array [
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
type stringrequired
Possible values: [user]
user_id cuidrequired
The unique identifier of the user
MOD2
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
Possible values: [agreement.draft.created, agreement.draft.updated, agreement.lifecycle.pending, agreement.lifecycle.fulfilled, agreement.lifecycle.finalized, agreement.lifecycle.cancelled, agreement.lifecycle.opened, 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.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_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]
The events that the webhook is subscribed to.
created_at stringrequired
UTC datetime ISO string
updated_at stringrequired
UTC datetime ISO string
]

Example (from schema)

{
  "version": "1.0",
  "result_type": "list",
  "resource_type": "webhook",
  "data": [
    {
      "id": "cfyuh2uzaka08n4fxzoexample",
      "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-05-10T12:45:39.352Z",
      "updated_at": "2024-05-10T12:45:39.352Z"
    }
  ]
}

400

GET /webhooks Error response

application/json

Schema

Schema

status stringrequired

Possible values: [error]

error objectrequired
code int64required
Possible values: >= 400 and <= 599
message stringrequired
request_id uuidrequired

Example (from schema)

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

Loading...