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 enterprise@countercyclical.io or schedule an enterprise demo!

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 webooks right in Countercyclical with Svix Play

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 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.

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.

PreviousPythonNextInsights

Last updated