Create an agency webhook endpoint
POST/agency/webhook-endpoints
One endpoint for the events of all the agency's live dealerships.
Each delivery is signed as a dealer endpoint's is, and adds
dealership_id to the body and a Vehiso-Dealer header naming the
dealership. A dealership that turns the agency's access off stops
sending. Sandboxes do not send here: make an endpoint inside a
sandbox with a test key instead. The signing_secret is in this
response only. Scope agency:webhooks:manage.
Request
Responses
- 201
- 401
- 403
- 422
- 429
The agency webhook endpoint, with its signing secret, shown this once.
Response Headers
This request's id. Quote it to support.
Requests allowed per minute for this key.
Requests left in the current minute.
true when this is the stored response to an earlier request with the same Idempotency-Key.
No key, or one that cannot be used. Codes: missing_api_key,
invalid_api_key, api_key_revoked, api_key_expired,
key_owner_inactive.
Response Headers
This request's id. Quote it to support.
Bearer.
The key may not do this. Codes: insufficient_scope,
scope_not_permitted_for_owner, plan_not_entitled,
secret_key_required, publishable_key_required,
secret_key_in_browser, origin_not_allowed, ip_not_allowed,
branch_move_not_permitted, plan_stock_cap_reached,
sandbox_stock_cap_reached, not_available_in_sandbox,
theme_builder_not_enabled, agency_key_required,
agency_not_approved, agency_access_revoked.
Response Headers
This request's id. Quote it to support.
The request was not valid. Code validation_failed, with errors
keyed by field; also body_not_received (a multipart body that
never arrived), webhook_endpoint_limit_reached,
vehicle_not_created, request_refused and
theme_publish_blocked (with errors.routes and errors.findings).
Response Headers
This request's id. Quote it to support.
Too many requests. Code rate_limited; wait Retry-After seconds. On POST /theme-generations, also theme_generation_quota_exceeded, when the dealer's monthly theme generations are used up (no Retry-After).
Response Headers
This request's id. Quote it to support.
Requests allowed per minute for this key.
Requests left in the current minute.
Seconds to wait before retrying.