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

# Create a webhook endpoint

`POST /api/v0/webhook_endpoints`

## Request

- Base URL: `https://www.getonbrd.com`
- URL: `https://www.getonbrd.com/api/v0/webhook_endpoints`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/getonbrd/apis/get-on-board-api/docs/api/v0/webhook_endpoints/post.ts> (a function with typed inputs; its response is checked against the schema)

Webhook setup flow: list valid events with `GET /api/v0/webhook_events`, create an endpoint with an HTTPS `endpoint` URL and selected `events`, then use `GET /api/v0/webhook_endpoints` to confirm the saved subscription.

## Headers

- `Authorization` string, required

## Request body `application/x-www-form-urlencoded`

- object
  - `endpoint` string, required
  - `events` string[], required

## Response `200`

Creates a new webhook endpoint with the specified events.

- object
  - `data` object, required
    - `id` string, required
    - `type` string, required
    - `attributes` object, required
      - `endpoint` string, required
      - `state` string, required
      - `events` string[], required

## Other responses

- `422`: Creates a new webhook endpoint with the specified events.

---

[API](https://skmtc.dev/getonbrd/apis/get-on-board-api.md) - [All operations](https://skmtc.dev/getonbrd/apis/get-on-board-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getonbrd/apis/get-on-board-api/revisions/f8405113049f?raw)