Skip to main content
POST
/
webhooks
Create Webhook
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/webhooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    "<string>"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "description": "<string>",
  "events": [
    "<string>"
  ],
  "enabled": true,
  "consecutive_failures": 123,
  "auto_disabled_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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
string[]
required

Response

Webhook created successfully

​
id
string<uuid>

Unique identifier for the webhook

​
url
string<uri>

Webhook URL

​
description
string | null

Webhook description

​
events
string[]

Events that trigger this webhook

​
enabled
boolean

Whether the webhook is enabled

​
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

​
created_at
string<date-time>

Webhook creation timestamp

​
updated_at
string<date-time>

Webhook last update timestamp