# Apiable Webhooks API

**Canonical:** https://apis.io/apis/apiable/apiable-webhooks-api/  
**Provider:** Apiable — https://apis.io/providers/apiable/  
**Base URL:** https://developer.apiable.io  
**Documentation:** https://www.apiable.io/docs/api-reference/

Apiable Webhooks API is one of 13 APIs that [Apiable](https://apis.io/providers/apiable/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

# How Webhooks Work Webhooks are a way for services to communicate with each other in real time. When an event occurs, the Webhook sends an HTTP POST request to the URL that you've configured. The Webhook itself is unaware of any specific authorization mechanisms like the Apiable Lambda authorizer, and the Webhook URL can be any endpoint capable of receiving HTTP POST requests. Optionally, you can include custom headers in the request. These headers will be appended automatically by the Webhook to the HTTP POST request, adding any additional information required for the endpoint. ## Testing a Webhook before posting You can test a Webhook by sending a POST request to the Webhook URL manually. Here’s an example curl command that simulates the Webhook sending a POST request: ```bash curl -X POST https:/apiable.example.io/webhook \ -H "Content-Type: application/json" \ -H "api-key: MY-API-KEY" \ -H "Custom-Header-1: value1" \ -H "Custom-Header-2: value2" \ -d '{ "id": "67040bcb1eb964694d999a68", "events": [ "SUBSCRIPTION_CREATED" ], "whsec": "whsec_CoX***pc=" }' ``` ## Example Webhook Configuration In the following example, a Webhook is configured to send an HTTP POST request to a URL upon the occurrence of a `SUBSCRIPTION_CREATED` event. The parameters "whsec" and "headers" are optional. ```json { "id": "67040bcb1eb964694d999a68", "events": [ "SUBSCRIPTION_CREATED" ], "url": "https:/apiable.example.io/webhook", "headers": { "api-key": "MY-API-KEY", "Custom-Header-1": "value1", "Custom-Header-2": "value2" } } ```

## Operations (7)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/webhooks/{id}` | Retrieve a webhook by ID |
| PUT | `/api/webhooks/{id}` | Update webhook |
| DELETE | `/api/webhooks/{id}` | Unregister a webhook |
| GET | `/api/webhooks` | Retrieve Registered Webhooks |
| POST | `/api/webhooks` | Register a webhook |
| GET | `/api/webhooks/{id}/test` | Test a webhook by ID |
| GET | `/api/webhooks/{id}/history` | Retrieve the history of webhook results for the past 24 hours |

## Machine-readable artifacts (9)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/openapi/apiable-webhooks-api-openapi.yml
- **APIReference** — https://www.apiable.io/docs/api-reference/
- **Documentation** — https://www.apiable.io/docs/automation/
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/authentication/apiable-authentication.yml
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/scopes/apiable-scopes.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/asyncapi/apiable-webhooks.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/errors/apiable-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/conventions/apiable-conventions.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/data-model/apiable-data-model.yml

## Other Apiable APIs (12)

- [Apiable API Portal Platform](https://apis.io/apis/apiable/api-portal-platform/)
- [Apiable Companies API](https://apis.io/apis/apiable/apiable-companies-api/)
- [Apiable Custom Properties API](https://apis.io/apis/apiable/apiable-custom-properties-api/)
- [Apiable Docs API](https://apis.io/apis/apiable/apiable-docs-api/)
- [Apiable Files API](https://apis.io/apis/apiable/apiable-files-api/)
- [Apiable Invitations API](https://apis.io/apis/apiable/apiable-invitations-api/)
- [Apiable Plans API](https://apis.io/apis/apiable/apiable-plans-api/)
- [Apiable Products API](https://apis.io/apis/apiable/apiable-products-api/)
- [Apiable Subscriptions API](https://apis.io/apis/apiable/apiable-subscriptions-api/)
- [Apiable Teams API](https://apis.io/apis/apiable/apiable-teams-api/)
- [Apiable Users API](https://apis.io/apis/apiable/apiable-users-api/)
- [Apiable Server Info API](https://apis.io/apis/apiable/apiable-server-info-api/)

## Tags

Webhook

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/apiable/apiable-webhooks-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/apiable/.