FIfirma
Webhooks

Create Webhook

Changed on

Create a new webhook

post/webhooks

Request

Request body

urlstring uri required
eventsstring[] required

Array of event types to subscribe to. See the full list for available events including organization seal and signing request seal events.

workspace_idstring uuid

Optional workspace ID. When provided, creates a workspace-scoped webhook. When omitted, creates a company-level webhook.

Response

Webhook created successfully

idstring uuid required

Unique identifier for the webhook

urlstring uri required

Webhook URL

descriptionstring nullable

Webhook description

eventsstring[] required

Events that trigger this webhook

enabledboolean required

Whether the webhook is enabled

consecutive_failuresinteger

Number of consecutive delivery failures

auto_disabled_atstring date-time nullable

Timestamp when the webhook was auto-disabled due to failures

created_atstring date-time required

Webhook creation timestamp

updated_atstring date-time

Webhook last update timestamp

Changes

  • d5b38481168aRevision changes
    • breaking

      removed the enum value signing_request.credits.purchased of the request property /

    • breaking

      removed the enum value signing_request.declined of the request property /

    • breaking

      removed the enum value signing_request.field.completed of the request property /

    • breaking

      removed the enum value signing_request.resent of the request property /

    • breaking

      removed the enum value signing_request.voided of the request property /

    • breaking

      removed the enum value template.created of the request property /

    • breaking

      removed the enum value template.deleted of the request property /

    • breaking

      removed the enum value template.field.added of the request property /

    • breaking

      removed the enum value workspace.deleted of the request property /

    • info

      added the new signing_request.certificate.generated enum value to the request property /

    • info

      added the new signing_request.recipient.declined enum value to the request property /

    • info

      added the new signing_request.recipient.identity_changed enum value to the request property /

    • info

      added the new signing_request.recipient.signed enum value to the request property /

    • info

      added the new signing_request.reminder.sent enum value to the request property /

    • info

      added the new signing_request.updated enum value to the request property /

  • f179958c3beeRevision changes
    • breaking

      request property / was restricted to a list of enum values

    • info

      added the new domain.verification.failed enum value to the request property /

    • info

      added the new domain.verified enum value to the request property /

    • info

      added the new organization_seal.created enum value to the request property /

    • info

      added the new organization_seal.deleted enum value to the request property /

    • info

      added the new organization_seal.erased enum value to the request property /

    • info

      added the new organization_seal.updated enum value to the request property /

    • info

      added the new signing_request.cancelled enum value to the request property /

    • info

      added the new signing_request.completed enum value to the request property /

    • info

      added the new signing_request.created enum value to the request property /

    • info

      added the new signing_request.credits.purchased enum value to the request property /

    • info

      added the new signing_request.declined enum value to the request property /

    • info

      added the new signing_request.deleted enum value to the request property /

    • info

      added the new signing_request.expired enum value to the request property /

    • info

      added the new signing_request.field.completed enum value to the request property /

    • info

      added the new signing_request.resent enum value to the request property /

    • info

      added the new signing_request.seal.applied enum value to the request property /

    • info

      added the new signing_request.seal.paused enum value to the request property /

    • info

      added the new signing_request.seal.swapped enum value to the request property /

    • info

      added the new signing_request.sent enum value to the request property /

    • info

      added the new signing_request.viewed enum value to the request property /

    • info

      added the new signing_request.voided enum value to the request property /

    • info

      added the new template.created enum value to the request property /

    • info

      added the new template.deleted enum value to the request property /

    • info

      added the new template.field.added enum value to the request property /

    • info

      added the new template.updated enum value to the request property /

    • info

      added the new template.used enum value to the request property /

    • info

      added the new workspace.created enum value to the request property /

    • info

      added the new workspace.deleted enum value to the request property /

    • info

      added the new workspace.updated enum value to the request property /