WebhookEndpoint

object

idrequired: Id
Opaque record id.
kindrequired: "endpoint" | "rest_hook"
namerequired: string or null
urlrequired: string
Endpoints: the URL as entered. REST hooks: masked (the URL is a credential).
eventsrequired: array of string
api_versionrequired: WebhookApiVersion
Dated payload version; additive changes ship without a new one.
triggerrequired: AutomationTriggerKey or null
apprequired: "zapier" | "make" | "pabbly" | "other" or null
api_keyrequired: object or null
api_key.idrequired: Id
Opaque record id.
api_key.namerequired: string
api_key.prefixrequired: string
is_activerequired: boolean
disabled_reasonrequired: string or null
failures · gone (410) · api_key_revoked · manual
disabled_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
failure_countrequired: integer
Failed attempts since the last success.
last_delivery_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
last_success_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
last_failure_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
previous_secret_expires_atrequired: DateTime or null
After a rotation the previous secret still signs until then.
created_byrequired: MemberRef or null
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "kind": "endpoint",
  "name": "string",
  "url": "string",
  "events": [
    "string"
  ],
  "api_version": "2026-10-01",
  "trigger": "new_lead",
  "app": "zapier",
  "api_key": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "prefix": "string"
  },
  "is_active": true,
  "disabled_reason": "string",
  "disabled_at": "2026-10-06T05:30:00.000Z",
  "failure_count": 0,
  "last_delivery_at": "2026-10-06T05:30:00.000Z",
  "last_success_at": "2026-10-06T05:30:00.000Z",
  "last_failure_at": "2026-10-06T05:30:00.000Z",
  "previous_secret_expires_at": "2026-10-06T05:30:00.000Z",
  "created_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "created_at": "2026-10-06T05:30:00.000Z",
  "updated_at": "2026-10-06T05:30:00.000Z"
}

{ "id": "cmusrceel0000q7kaafxqi1om", "kind": "endpoint", "name": "string", "url": "string", "events": [ "string" ], "api_version": "2026-10-01", "trigger": "new_lead", "app": "zapier", "api_key": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "prefix": "string" }, "is_active": true, "disabled_reason": "string", "disabled_at": "2026-10-06T05:30:00.000Z", "failure_count": 0, "last_delivery_at": "2026-10-06T05:30:00.000Z", "last_success_at": "2026-10-06T05:30:00.000Z", "last_failure_at": "2026-10-06T05:30:00.000Z", "previous_secret_expires_at": "2026-10-06T05:30:00.000Z", "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }