v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Webhooks

Public API

Get Webhook

Returns the full configuration of a single webhook owned by the authenticated user, including its name, URL, format, monitored fields and post fields when applicable, events, creation datetime, and last-sent datetime. Returns 403 if the webhook exists but belongs to a different user, and 404 if the webhook does not exist.

OAuth Scopes: webhooks

get/api/v1/webhooks/{id}

Path parameters

idinteger required

The webhook ID to retrieve.

Response

The full configuration of the requested webhook.

idstring

The ID of the webhook.

namestring

The name of the webhook.

createdstring

Datetime when the webhook was created (UTC, format: YYYY-MM-DD HH:MM:SS).

lastSentstring nullable

Datetime when the webhook was last fired (UTC, format: YYYY-MM-DD HH:MM:SS). Null if the webhook has never fired.

monitorFieldsstring[] nullable

A list of fields being monitored. Null when the webhook is not configured to monitor fields (e.g. event-only webhooks).

postFieldsobject

A map of field ID or alias to the external name used in the webhook payload.

urlstring

The URL the webhook sends data to.

format'json' | 'form-encoded'

The payload format used by the webhook.

includeCompanyDomainboolean

Whether the company domain is added to the webhook request header.

eventsWebhookEventType[]

Events that trigger this webhook.

Example response

{
  "id": "4",
  "name": "Example Webhook",
  "created": "2021-09-20 22:38:01",
  "lastSent": "2021-09-20 22:38:01",
  "monitorFields": [
    "firstName",
    "lastName"
  ],
  "postFields": {
    "firstName": "Name",
    "lastName": "Surname",
    "dateOfBirth": "DOB"
  },
  "url": "https://www.example.com",
  "format": "json",
  "events": [
    "employee_with_fields.created",
    "employee_with_fields.updated"
  ],
  "errors": [
    {
      "error": "Permission denied to the following fields",
      "postFields": [
        {
          "id": 2,
          "name": "lastName"
        }
      ]
    }
  ]
}