Webhooks
Tickaroo uses webhooks to notify your application when an event happens in your organization. Webhooks are particularly useful for realtime liveblog updates.
Events
ticker_update
This event is triggerd with every liveblog update within our organization. Each subscribed endpoint will be called with a POST Request.
Payload
{
"event_type": "ticker_update",
"ticker_id": "YOUR_TICKER_ID",
"local_id": "YOUR_TICKER_LOCAL_ID",
"version": "CURRENT_TICKER_VERSION"
}
API Endpoints
Subscribe
Request: POST /api/v5/webhooks/subscribe.json
Query Parameters:
organization_id
: The organization to subscribe tourl
: The URL to subscribe
Success Response: Tik::Model::ApiSuccess
Unsubscribe
Request: POST /api/v5/webhooks/unsubscribe.json
Query Parameters:
organization_id
: The organization to unsubscribe tourl
: The URL to unsubscribe
Success Response: Tik::Model::ApiSuccess
Subscriptions
Request: GET /api/v5/webhooks/index.json
Query Parameters:
organization_id
: The organization with subscriptions
Success Response:
{
"urls": ["url1", "url2"]
}