---
title: "Create a webhook endpoint"
method: POST
path: "/webhooks"
tags: ["Webhooks"]
---

# Create a webhook endpoint

`POST /webhooks`

Create a new webhook endpoint to receive events from Bridge. Webhook endpoints begin in a disabled state and can be enabled with a PUT request. A maximum of 5 webhooks can be active or disabled at one time. Webhook endpoints can be created in Sandbox, but no webhook events will be sent.

## Headers

- `Idempotency-Key` string, required

## Request body

- CreateWebhook
  - `url` string, required — The URL that the webhook will send events to. It must use the HTTPS scheme and have a valid X.509 certificate. The URL doesn't need to be live, but the host must be reachable.
  - `event_epoch` 'webhook_creation' | 'beginning_of_time', required — Specifies the starting point from which this webhook will receive events. This should usually be set to "webhook_creation", unless there is a reason why this webhook needs to process events from before its creation. When this value is set to "webhook_creation", the webhook will receive a small number of events preceding its creation for convenience.
  - `event_categories` WebhookEventCategory[] — The list of event categories that the webhook endpoint will receive

## Response `201`

Webhook endpoint created

- Webhook
  - `id` string, required — An identifier that uniquely identifies the webhook endpoint
  - `url` string, required — The URL that the webhook will send events to
  - `status` 'active' | 'disabled' | 'deleted', required — The status of the webhook. Only active webhooks will receive events automatically.
  - `public_key` string, required — The public key (in PEM format) that should be used to verify the authenticity of webhook events
  - `event_categories` WebhookEventCategory[] — The list of event categories that the webhook endpoint will receive

## Other responses

- `400` — Request containing missing or invalid parameters.
- `401` — Missing or invalid API key
- `500` — Unexpected error. User may try and send the request again.

---

[API](https://skmtc.net/bridge/apis/bridge-api.md) · [All operations](https://skmtc.net/bridge/apis/bridge-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bridge/bridge-api/versions/570998bde3b5/schema)