Webhooks

Subscribe to real-time events on Countercyclical with webhooks.

Last updated 4 months ago

Webhooks

Subscribe to real-time events on Countercyclical with webhooks.

This feature is only available for our Enterprise customers. For more information, please contact us at or

What are Webhooks?

Webhooks are user-defined HTTP callbacks that are triggered by specific events on the platform. When such an event occurs, the platform makes an HTTP POST request to the URL you have configured for the webhook. This allows you to receive immediate notifications and take appropriate actions based on the event data.

Adding a Webhook

We allow you to test your webhooks right in Countercyclical with

Create a Webhook URL

First, you need to set up a URL on your server that can accept incoming HTTP POST requests. This URL will be the endpoint that our platform sends webhook events to.

To register a webhook, follow these steps:

Navigate to the Webhooks Section

Log in to your Enterprise account on the platform.
Go to the Settings > Workspace > Advanced > Developers
Scroll to the Webhooks section.

Create a New Webhook

Click on the Create Webhook button.
Fill in the required details:
- Name: A name for your webhook (e.g., "New Report Published")
- URL: The subscriber endpoint URL where you want to receive the webhook events
- Events: Select the events you want to subscribe to

Save the Webhook:

Once you have filled in all the details, click Save.

Managing Webhooks

You can manage your webhooks through the platform's Webhooks section:

Edit Webhooks: Modify the details of an existing webhook (e.g., change the URL or events).
Delete Webhooks: Remove a webhook if you no longer need it.
View Logs: Access logs to see the history of webhook events sent to your endpoint.

Supported Events and Example

This section may be updated at any point in the future. We try to keep our webhook events close to/at parity with the generally available PUT, POST, and/or DELETE REST API endpoints you'd find in Endpoints

Below you can find an example of what a common payload will look like, along with the supported events we have on Countercyclical.

Supported Events

Like API Keys, Webhooks created on the platform are scoped based on the user's permission in the workspace.

For the greatest possible visibility across all supported events, we'd recommend having a workspace owner or admins create & manage webhooks. For more information on roles, please see Permissions

Here is a list of supported webhook events across the platform:

Update events (e.g. *.updated) may only capture top-level updates to the core resource in question based on how our system is set up. If there's a particular event you're looking to capture, it may require an additional event to be created for your use case(s).

Payload Example

{
    "id": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
    "eventId": "DUZOjLYj5BwYP6SKfCFbloaX",
    "eventType": "investment.created",
    "timestamp": "2024-11-19 08:29:33.26-06",
    "workspaceId": "7WLHlmQyWCsv1xocMkXK-L4A",
    "applicationId": "TXH5g6eH5pOlozDp0PjMeDYh",
    "payload": {
        "id": "xH6_TtItZImSpCghKUR-FiOP",
        "tickerSymbol": "KO",
        "name": "Coca-Cola Co",
        "description": "The Coca-Cola Company is an American multinational corporation founded in 1892, best known as the producer of Coca-Cola. The drink industry company also manufactures, sells, and markets other non-alcoholic beverage concentrates and syrups, and alcoholic beverages.",
        "address": "1 Coca Cola Plz NW",
        "country": "US",
        "cik": "0000021344",
        "lei": "UWJKFUJFZ02DKWI3RY53",
        "figi": "BBG000BMX4N8",
        "foundingDate": "1892",
        "ipoDate": "1919",
        "headquarters": "Atlanta, GA",
        "ceo": "James Quincey",
        "employees": 82500,
        "exchange": "NYSE",
        "industry": "Beverages",
        "sector": "Manufacturing",
        "issuance": "cs",
        "website": "https://www.coca-colacompany.com",
        "tags": ["Consumer Non-Durables", "Beverages: Non-Alcoholic", "Manufacturing", "Soft Drink Manufacturing"],
        "createdAt": "2024-08-24T15:26:19.628Z",
        "updatedAt": "2024-08-24T15:26:19.628Z",
        "editedName": "Coca-Cola Co",
        "financingType": "Equity",
        "marketType": "Public",
        "type": "Personal",
        "visibility": "Private",
        "isFavorite": false,
        "isLocked": false,
        "isArchived": false,
        "bannerImage": null,
        "clearbit": {...}
    }
}

Best Practices

Securing your Webhook Endpoints

To ensure the security of your webhook, consider the following:

Validate the Source: Verify that the incoming requests are actually coming from our platform. This can be done by checking the request headers or using a shared secret.
Use HTTPS: Ensure your webhook URL uses HTTPS to encrypt the data in transit.
Rate Limiting: Implement rate limiting to prevent abuse of your webhook endpoint.

PreviousPipelines NextSecurity

Last updated 4 months ago