Create a webhook subscription.
POST/webhooks
Registers an HTTPS endpoint to receive the given event types. The subscription covers the authenticated user's entire portfolio — owned listings plus listings shared with them to manage — and each delivery names only listings they can access.
The response is the only place the signing secret appears; store it, because it cannot be read back afterwards. If you lose it, use POST /webhooks/{id}/rotate_secret.
The endpoint must be https. Deliveries begin with the next batch window.
Request
Responses
- 201
- 400
- 401
- 403
- 409
- 422
- 429
The created subscription, including its signing secret.
An unknown event type was provided, or a required field was missing.
API key authorization failed.
The API key is read-only and may not be used to create a webhook.
A concurrent webhook request for this user is already in progress. Retry once it completes.
The endpoint was rejected. It must be an https URL on port 443 that
resolves to a publicly routable address. This is re-checked before every
delivery, so an endpoint that stops meeting it also stops receiving events.
Rate limit exceeded — the API key has sent too many requests. Wait before retrying. See the Rate Limits section in the overview for the recommended exponential backoff strategy.