Skip to main content

CreateWebhookModel

Create webhook model.

Breaking Changes​

No breaking changes.

Examples​

Fill this template out with real values.

{
"events": "array[hook_event]",
"secret": "String, optional",
"url": "String"
}

Fields​

events Array[hook_event], Required

hook_event String

Hook event.

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

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.