Skip to content
FirmEasy
← Inicio

List Webhooks

GET
https://app.firmeasy.legal/api/v1/webhooks

List Webhooks

Section titled “List Webhooks”

Allows you to get a paginated list of configured webhooks, with the ability to filter and sort the results.

Required Headers

Section titled “Required Headers”
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'

Search Parameters (Query Params)

Section titled “Search Parameters (Query Params)”
per_page
integer
Number of results per page.
Limits:Optional
page
integer
Current page number.
Limits:Optional
document_token
string
Filters webhooks associated with a specific document.
Limits:Optional
sort_by
string
Field to sort by (defaults to created_at).
Limits:Optional
sort_order
string
Result order: asc or desc.
Limits:Optional
event
string
Filter by configured event type (e.g.: document_created, signer_rejected).
Limits:Optional
active
boolean
Filter by active or inactive webhooks.
Limits:Optional

Response Example

Section titled “Response Example”
{
  "items": [
    {
      "id": "c71d4e53-28f2-4a17-9b82-6f3a9a2e4d97",
      "user": "e4f9b215-6a2d-49b0-a76a-8f25d73f9d3e",
      "document": null,
      "event": "signer_rejected",
      "target_url": "[https://hooks.empresaglobal.com/events/c71d4e53-28f2-4a17-9b82-6f3a9a2e4d97](https://hooks.empresaglobal.com/events/c71d4e53-28f2-4a17-9b82-6f3a9a2e4d97)",
      "active": true,
      "secret_key": "3K92MQLX7FJ0P1V8H6RC5T4YNE",
      "custom_headers": null,
      "signed_headers": null,
      "type": "E",
      "created_at": "2024-11-22T14:45:10.000000Z",
      "updated_at": "2024-11-22T14:45:10.000000Z"
    }
  ],
  "pagination": {
    "total_items": 2,
    "total_pages": 2,
    "current_page": 1,
    "per_page": 1,
    "next_page_url": "[https://api.empresaglobal.com/v1/webhooks?per_page=1&page=2](https://api.empresaglobal.com/v1/webhooks?per_page=1&page=2)",
    "first_page_url": "[https://api.empresaglobal.com/v1/webhooks?per_page=1&page=1](https://api.empresaglobal.com/v1/webhooks?per_page=1&page=1)",
    "last_page_url": "[https://api.empresaglobal.com/v1/webhooks?per_page=1&page=2](https://api.empresaglobal.com/v1/webhooks?per_page=1&page=2)"
  }
}
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 will trigger 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 to send.
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.

Pagination Fields

Section titled “Pagination Fields”

The response includes a pagination object with detailed information to manage navigation between pages:

total_items
integer
Total number of records available in the query.
total_pages
integer
Total number of pages calculated based on items per page.
current_page
integer
Current page number being viewed.
per_page
integer
Maximum number of items returned per page.
next_page_url
string/null
URL for the next page, if it exists.
first_page_url
string
First page URL.
last_page_url
string
Last page URL.