# Webhooks {% hint style="info" %} This feature is only available for our Enterprise customers. For more information, please contact us at or [schedule an enterprise demo](https://cal.com/countercyclical/enterprise-demo) {% endhint %} ## 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 {% hint style="info" %} We allow you to test your webhooks right in Countercyclical with [Svix Play](https://www.svix.com/play/) {% endhint %} ### **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 {% hint style="info" %} 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](/developers/endpoints.md) Please feel free to reach out to us at if you have any questions or suggestions {% endhint %} 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 {% hint style="warning" %} 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](/fundamentals/settings/workspace/permissions.md) {% endhint %} Here is a list of supported webhook events across the platform: * `investment.created` : Action taken when an [Investment](/fundamentals/investments.md) is created * `investment.updated`: Action taken when an [Investment](/fundamentals/investments.md) is updated * `investment.deleted`: Action taken when an [Investment](/fundamentals/investments.md) is deleted * `valuation.created`: Action taken when a [Valuation](/fundamentals/valuations-legacy.md) is created * `valuation.updated`: Action taken when a [Valuation](/fundamentals/valuations-legacy.md) is updated * `valuation.deleted`: Action taken when a [Valuation](/fundamentals/valuations-legacy.md) is deleted * `memo.created`: Action taken when a [Memo](/fundamentals/memos.md) is created * `memo.updated`: Action taken when a [Memo](/fundamentals/memos.md) is updated * `memo.deleted`: Action taken when a [Memo](/fundamentals/memos.md) is deleted * `team.created`: Action taken when a [Team](/fundamentals/teams.md) is created * `team.updated`: Action taken when a [Team](/fundamentals/teams.md) is updated * `team.deleted`: Action taken when a [Team](/fundamentals/teams.md) is deleted * `assumption.created`: Action taken when an [Assumption](/fundamentals/valuations-legacy/assumptions.md) is created * `assumption.updated`: Action taken when an [Assumption](/fundamentals/valuations-legacy/assumptions.md) is updated * `assumption.deleted`: Action taken when an [Assumption](/fundamentals/valuations-legacy/assumptions.md) is deleted * `pipeline.created`: Action taken when a [Pipeline](/fundamentals/pipelines.md) is created * `pipeline.updated`: Action taken when a [Pipeline](/fundamentals/pipelines.md) is updated * `pipeline.deleted`: Action taken when a [Pipeline](/fundamentals/pipelines.md) is deleted {% hint style="info" %} 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). Please reach out to us as if you'd like to see us add any additional events {% endhint %} ### Payload Example ```json { "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. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.countercyclical.io/developers/webhooks.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.