Skip to main content
POST
@firma-dev/sdk

Authorizations

Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Body

application/json
url
string<uri>
required
events
enum<string>[]
required

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

Available options:
signing_request.created,
signing_request.sent,
signing_request.viewed,
signing_request.completed,
signing_request.declined,
signing_request.cancelled,
signing_request.expired,
signing_request.voided,
signing_request.field.completed,
signing_request.deleted,
signing_request.resent,
signing_request.credits.purchased,
template.created,
template.updated,
template.deleted,
template.field.added,
template.used,
workspace.created,
workspace.updated,
workspace.deleted,
domain.verified,
domain.verification.failed,
organization_seal.created,
organization_seal.updated,
organization_seal.deleted,
organization_seal.erased,
signing_request.seal.applied,
signing_request.seal.paused,
signing_request.seal.swapped
workspace_id
string<uuid>

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

Response

Webhook created successfully

id
string<uuid>
required

Unique identifier for the webhook

url
string<uri>
required

Webhook URL

events
string[]
required

Events that trigger this webhook

enabled
boolean
required

Whether the webhook is enabled

created_at
string<date-time>
required

Webhook creation timestamp

description
string | null

Webhook description

consecutive_failures
integer

Number of consecutive delivery failures

auto_disabled_at
string<date-time> | null

Timestamp when the webhook was auto-disabled due to failures

updated_at
string<date-time>

Webhook last update timestamp