API reference
Create a webhook endpoint
Register an https destination URL for signed deliveries (Standard Webhooks: webhook-id, webhook-timestamp, webhook-signature headers). The whsec_ signing secret is returned ONCE in this response and never again - store it immediately. format=slack or discord posts native chat messages instead of the JSON payload. Tier caps: free 1, pro 5, scale 25 endpoints. Costs 0 credits; delivery is free on every tier.
AuthorizationBearer <token>
bx_-prefixed API key. Free keys: https://bixel.com/account/
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/watch/endpoints" \ -H "Content-Type: application/json" \ -d '{ "url": "string" }'{ "data": { "endpoint": { "id": "string", "url": "string", "format": "json", "status": "active", "disabled_reason": "string", "failing_since": "2019-08-24T14:15:22Z", "secret_previous_expires_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z" }, "secret": "string" }, "meta": { "generated_at": "2019-08-24T14:15:22Z", "count": 0, "total": 0, "next_cursor": "string", "notice": "string", "window": { "served_from": "string", "earliest_event_at": "string", "events_beyond_window": true }, "data_version": "string", "resolved_at": "2019-08-24T14:15:22Z", "attribution": { "source": "Bixel", "url": "string", "license": "CC-BY-4.0", "notice": "from Bixel", "data_version": "string" } }}{ "type": "http://example.com", "title": "string", "status": 0, "code": "company_not_found", "detail": "string", "hint": "string", "docs_url": "http://example.com"}{ "type": "http://example.com", "title": "string", "status": 0, "code": "company_not_found", "detail": "string", "hint": "string", "docs_url": "http://example.com"}{ "type": "http://example.com", "title": "string", "status": 0, "code": "company_not_found", "detail": "string", "hint": "string", "docs_url": "http://example.com"}