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

# Create webhook

`POST /webhooks`

Create an instance of WebhookView.

## Request body

- CreateWebhook — Command for creating a new webhook
  - `displayName` string, required — Display name for the webhook
  - `url` string — URL where webhook events will be sent
  - `authorization` string — Authorization header value for webhook commands
  - `active` boolean — Whether the webhook is active
  - `contactEmail` string — Email address to notify when webhook delivery errors occur
  - `errorThreshold` integer — Number of times a webhook will be retried and consecutive errors will result in an email notification
  - `integrationId` string, uuid — Id of the integration this webhook is associated with. This is required for 3rd party integrators
  - `webhookTopics` AddWebhookTopic[] — List of topics and configurations this webhook subscribes to
    - `topic` string, required — The topic name to subscribe to
    - `filters` UpdateWebhookFilter[], required — Advanced filtering configuration
      - `action` string, required — Action to filter on
      - `conditions` UpdateFilterCondition[], required — List of conditions that must all be true
        - `field` string, required — Field path to filter on
        - `operator` 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'LESS_THAN' | 'IN' | 'NOT_IN' | 'CONTAINS', required — Filter operator for webhook conditions
        - `value` string[], required — Values to compare against

## Response `200`

The request has succeeded.

- Webhook
  - `id` string, uuid
  - `url` string, required
  - `sharedSecret` SharedSecret, required
    - `header` string
    - `credential` string, required
  - `createdDate` string, date-time, required

## Other responses

- `400` — The request is missing required parameters or has invalid parameters
- `401` — Missing or invalid token
- `403` — User does not have permission to access this resource
- `500` — Server error

---

[API](https://skmtc.dev/pax8/apis/authentication.md) · [All operations](https://skmtc.dev/pax8/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pax8/authentication/revisions/4026bf405528/schema)