Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-13103980.6 KB
Webhooks

Create webhook subscription

Create a webhook subscription to receive events.

Delivery URL Validation: The provided delivery_url will be validated synchronously by sending an HTTP POST request with an HMAC signature. If validation fails (network error, timeout, non-2xx response), the webhook will still be created but with status: "disabled" and disabled_reason: "delivery_url_validation_failed".

Delivery Timeout: Each delivery attempt has a hard 60-second timeout. Endpoints that do not respond within 60 seconds are recorded as failed deliveries (success: false, status_code: 0 on the event log) and follow the standard retry policy. Endpoints should acknowledge requests quickly (HTTP 2xx) and defer work asynchronously.

Important: Always check the status and disabled_reason fields in the response to ensure the webhook is active.

post/webhook/webhooks

Headers

x-apideck-app-idstring required

The ID of your Unify application

Request body

descriptionstring nullable

A description of the object.

unified_api'accounting' | 'ats' | 'calendar' | 'crm' | 'csp' | 'customer-support' | 'ecommerce' | 'email' | 'email-marketing' | 'expense-management' | 'file-storage' | 'form' | 'hris' | 'lead' | 'payroll' | 'pos' | 'procurement' | 'project-management' | 'script' | 'sms' | 'spreadsheet' | 'subscription-analytics' | 'team-messaging' | 'issue-tracking' | 'time-registration' | 'transactional-email' | 'vault' | 'data-warehouse' required

Name of Apideck Unified API

status'enabled' | 'disabled' required

The status of the webhook.

delivery_urlstring uri required

The delivery url of the webhook endpoint. The endpoint must respond within 60 seconds or the delivery is recorded as failed.

eventsWebhookEventType[] required

The list of subscribed events for this webhook. [*] indicates that all events are enabled.

Example request

{
  "description": "A description",
  "unified_api": "crm",
  "status": "enabled",
  "delivery_url": "https://example.com/my/webhook/endpoint",
  "events": [
    "vault.connection.created",
    "vault.connection.updated"
  ]
}

Response

Webhooks

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "data": {
    "id": "1234",
    "description": "A description",
    "unified_api": "crm",
    "status": "enabled",
    "disabled_reason": "retry_limit",
    "delivery_url": "https://example.com/my/webhook/endpoint",
    "execute_base_url": "https://unify.apideck.com/webhook/webhooks/1234/execute",
    "events": [
      "vault.connection.created",
      "vault.connection.updated"
    ],
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}