Skip to main content
GET
/
webhooks
/
{id}
Get Webhook
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/webhooks/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "enabled": true,
  "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.

Path Parameters

id
string<uuid>
required

Response

Webhook retrieved successfully

id
string<uuid>

Unique identifier for the webhook

url
string<uri>

Webhook URL

events
string[]

Events that trigger this webhook

enabled
boolean

Whether the webhook is enabled

created_at
string<date-time>

Webhook creation timestamp

updated_at
string<date-time>

Webhook last update timestamp

I