API reference
Create a watch subscription
Watch a list of companies for confirmed change events, optionally filtered to a subset of dimensions and routed to webhook endpoints. Company resolution is all-or-nothing: any identifier that does not match a covered company answers companies_unresolved and nothing is created. Tier caps count DISTINCT watched companies per account (free 25, pro 500, scale 5000) - there is never a per-company fee. Costs 0 credits.
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/subscriptions" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "companies": [ "string" ] }'{ "data": { "subscription": { "id": "string", "name": "string", "dimensions": [ "string" ], "active": true, "companies_count": 0, "endpoint_ids": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } }, "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 } }}{ "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"}