Get Webhook

GET

https://app.firmeasy.legal/api/v1/webhooks/{webhook_id}

Get Webhook

Allows you to get the complete configuration of a specific webhook using its id.

Required Headers

Parameter	Type	Description	Limits
`Authorization`	string	Access token obtained during login, with the 'Bearer' prefix.	Required
`Content-Type`	string	Specifies the content type of the HTTP request body. For requests that include JSON data	'application/json'

Authorization

string

Access token obtained during login, with the 'Bearer' prefix.

Limits:Required

Content-Type

string

Specifies the content type of the HTTP request body. For requests that include JSON data

Limits:'application/json'

Response Example

{
  "id": "b28f7c91-4d1e-48fb-87a1-62f4e913ad7d",
  "user": "a56d3c72-917e-42e8-b38f-5e4c8d9b143a",
  "document": null,
  "event": "signer_rejected",
  "target_url": "[https://hooks.empresaglobal.com/events/b28f7c91-4d1e-48fb-87a1-62f4e913ad7d](https://hooks.empresaglobal.com/events/b28f7c91-4d1e-48fb-87a1-62f4e913ad7d)",
  "active": true,
  "secret_key": "7V4J3PQX1LND8E0YB5MC2KRF6H",
  "custom_headers": null,
  "signed_headers": null,
  "type": "E",
  "created_at": "2024-11-10T09:18:32.000000Z",
  "updated_at": "2024-11-10T09:18:32.000000Z"
}

Nombre	Type	Description
`id`	string	Unique webhook identifier in Firmeasy.
`user`	string	ID of the webhook owner user.
`document`	string/null	Associated document if applicable, or null.
`event`	string	Configured event that triggers the webhook.
`target_url`	string	Configured destination URL.
`active`	boolean	Indicates if the webhook is active.
`secret_key`	string	Unique secret key used to sign payloads with HMAC.
`custom_headers`	array/null	Custom headers if any.
`signed_headers`	array/null	Signed headers (currently null).
`type`	string/null	Webhook type (reserved for future use).
`created_at`	datetime	Creation date.
`updated_at`	datetime	Last update.

id

string

Unique webhook identifier in Firmeasy.

user

string

ID of the webhook owner user.

document

string/null

Associated document if applicable, or null.

event

string

Configured event that triggers the webhook.

target_url

string

Configured destination URL.

active

boolean

Indicates if the webhook is active.

secret_key

string

Unique secret key used to sign payloads with HMAC.

custom_headers

array/null

Custom headers if any.

signed_headers

array/null

Signed headers (currently null).

type

string/null

Webhook type (reserved for future use).

created_at

datetime

Creation date.

updated_at

datetime

Last update.