Creates a new webhook for a dealership

URL Expired

The URL for this request expired after 30 days.

Webhook Parameters

dealership_id

• Type: integer
• Required: Yes
• Description: The id of the dealership

type

• Type: string
• Enum: required
• Allowed:
  • Webhook::Car
  • Webhook::Reservation

url

• Type: string
• Required: Yes

action

• Type: string
• Enum: required
• Allowed:
  • create
  • update
  • delete

object_version

• Type: integer
• Enum: required
• Allowed:
  • 2
  • 3

trigger

• Type: string | null
• Description: Optional subtype-specific event state for the webhook.

handshake

• Type: boolean
• Description: When true, Dealerware performs a nonce handshake before delivering the webhook payload.

auth_header_name

• Type: string | null
• Description: Optional custom request header name. Must be paired with auth_header_value when provided.

auth_header_value

• Type: string | null
• Description: Optional custom request header value. Must be paired with auth_header_name when provided.

active

• Type: boolean
• Description: Whether the webhook is active.

api-version

• Type: integer
• Required: Yes
• Description: Target API version

API Responses

201 Success

{
  "id": 1234,
  "dealership_id": 4321,
  "type": "Webhook::Car",
  "trigger": "string",
  "url": "https://my.api_url.com",
  "action": "create",
  "handshake": true,
  "object_version": 3,
  "auth_header_name": "Authorization",
  "auth_header_value": "b62b792b4e0c802a4cf9e2b5a869a55a78a98ca57c88c368120e84a994e2df41",
  "active": true
}

Error Codes

• 401 Unauthorized
• 403 Forbidden
• 404 Not found
• 415 Unsupported Media Type
• 422 Unprocessable Content

Updated 3 months ago