Skip to main content

WebhookModel

Webhook model.

Breaking Changes​

No breaking changes.

Examples​

Fill this template out with real values.

{
"deleted_at": "String",
"events": "array[hook_event]",
"id": "Integer",
"last_http_fail": "String",
"last_http_success": "String",
"secret": "String, optional",
"url": "String"
}

Fields​

deleted_at String, Required

Denial date.

  • Date in an ISO 8601 compatible format.

events Array[hook_event], Required

hook_event String

Hook event.

  • Must be a valid hook event (one of: Ping, Customer, CustomerLocation, Job, Truck).

id Integer, Required

Resource identifier.

last_http_fail String, Required

Last time of url webhook execution failure.

  • Date in an ISO 8601 compatible format.

last_http_success String, Required

Last time of url webhook execution success.

  • Date in an ISO 8601 compatible format.

secret String, Optional

Response body HMAC signing key.

  • Matches ^\s[a-zA-Z0-9\/+=]{11,270}\s$
  • Base64 encoded string.

url String, Required

Callback URL.

  • URL conforming to RFC 1738.