Returns a paginated list of dealership webhooks

URL Expired

The URL for this request expired after 30 days.

API Parameters

• dealership_id (integer, required): The id of the dealership
• page (integer): The page number to fetch, defaulting to 1.
• per_page (integer): The number of webhook records to return, defaulting to 30.
• api-version (integer, required): Target API version

Responses

200 Success

Array of Objects

• id (integer, required)
• dealership_id (integer, required): Dealership that owns the webhook.
• type (string, enum, required): Webhook::Car or Webhook::Reservation
• trigger (string | null, required): Optional subtype-specific event state for the webhook.
• url (string, required)
• action (string, enum, required): create, update, or delete
• handshake (boolean, required): Whether nonce-based handshake verification is enabled.
• object_version (integer, enum, required): 2 or 3
• auth_header_name (string | null, required): Optional custom request header name.
• auth_header_value (string | null, required): Optional custom request header value.
• active (boolean, required): Whether the webhook is currently active.

Example Object

[
  {
    "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 Responses

• 401 Unauthorized
• 403 Forbidden
• 404 Not Found
• 406 Not Acceptable

Base URL

https://api.dealerware.com/admin/dealerships/{dealership_id}/webhooks

Example cURL Request

curl --request GET \
     --url https://api.dealerware.com/admin/dealerships/dealership_id/webhooks \
     --header 'accept: application/json'