CreateWebhookRequest

Schema for creating a new webhook

nameName (string)required

Possible values: non-empty and <= 255 characters

description object

anyOf

• string
• null

string

Possible values: <= 500 characters

urlstring<uri>required

Possible values: non-empty and <= 2048 characters

eventsstring[]

headers object

anyOf

• object
• null

object

auth_typeAuthTypeEnum (string)

Webhook authentication types

Possible values: [none, bearer, basic, api_key]

Default value: none

auth_config object

anyOf

• object
• null

object

methodMethodEnum (string)

HTTP methods for webhooks

Possible values: [POST, PUT, PATCH, GET]

Default value: POST

content_typeContent Type (string)

Possible values: <= 100 characters

Default value: application/json

custom_payload_template object

anyOf

• string
• null

string

is_activeIs Active (boolean)

Default value: true

max_retriesMax Retries (integer)

Possible values: >= 0 and <= 10

Default value: 3

timeout_secondsTimeout Seconds (integer)

Possible values: >= 1 and <= 300

Default value: 30

rate_limit_per_minuteRate Limit Per Minute (integer)

Possible values: >= 1 and <= 1000

Default value: 60

CreateWebhookRequest

{
  "auth_config": {
    "token": "your-bearer-token"
  },
  "auth_type": "bearer",
  "content_type": "application/json",
  "description": "Notifies dispatch when vehicles enter warehouse zones",
  "events": [
    "enter",
    "exit"
  ],
  "headers": {
    "X-Custom-Header": "fleet-tracker"
  },
  "is_active": true,
  "max_retries": 3,
  "method": "POST",
  "name": "Fleet Entry Alerts",
  "rate_limit_per_minute": 60,
  "timeout_seconds": 30,
  "url": "https://example.com/webhooks/geofence-events"
}