Webhooks

Webhooks (also called web callbacks) allow our services to notify updates to your own services using HTTP requests. In order to receive updates when our data changes, instead of constantly polling our API, you can subscribe to the events that you are interested in (like when an item is created or deleted) and we will notify you when this happens in order to update the precise part of our data at the precise time.

Unlike SignalR, this method has the benefit that it does not require to maintain an open network connection between our servers and your own server. As a result, this method is much more efficient on both sides.

Does It Work?

Let's imagine you use our Economic Calendar API and you want to get all new events when they are created. You should implement an API endpoint on your side that receives the data object and processes it (updates your data). Then, you should just tell our service which is the endpoint URL where you want to receive that event notification. This way, when our editors create a new event, our service will make an HTTP request to the endpoint you defined notifying you that the event X was created.

Step 1. Implement your webhook endpoint

First, you should look at which events you are interested in. Then, you should take a look at the payload objects in our API documentation and implement one or more endpoints that can receive and process those events.

Step 2. Register the webhook endpoint using our API

When you have implemented your webhook endpoint, you should use our API to register it. After you have done it, our service will automatically notify you when events happen. Please take a look at the webhooks section of each API to understand how to register and manage your webhooks.

Implementations

Currently, we have implemented webhooks for our Economic Calendar API and for our News API.