---
title: "Create a webhook"
method: POST
path: "/web_hooks"
---

# Create a webhook

`POST /web_hooks`

## Request

- Base URL: `https://gateway.pmnts-sandbox.io/v1.0`
- URL: `https://gateway.pmnts-sandbox.io/v1.0/web_hooks`
- Auth: HTTP basic

Create webhooks

## Request body

- object
  - `name` string: A name for the web hook
  - `mode` string: The mode for the web hook. Possible values are: Test or Production
  - `address` string: The URL for the web hook to target. This must start with http:// or https://
  - `authentication_username` string: The username for HTTP Basic authentication
  - `authentication_password` string: The password for HTTP Basic authentication (optional)
  - `is_active` boolean: Activation flag for the webhook
  - `events` string: A list of events for the web hook to target. This is a comma separated list of events, and it is possible to use wildcards (e.g.`*` for all events, or `direct_entry:*` for all direct entry hooks, or `direct_entry:created,direct_entry:failed`)

## Response `200`

200

- object
  - `successful` boolean
  - `response` object
    - `address` string
    - `events` string
    - `mode` string
    - `authentication_username` unknown
    - `authentication_password` string
    - `is_active` boolean
    - `name` string
    - `id` string
  - `errors` unknown[]
    - unknown
  - `test` boolean

## Other responses

- `422`: 422

## Changes

- **2026-11-03** `a62ddbae3800`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/fatzebra/apis/gateway/changes/web_hooks/post.md)

---

[API](https://skmtc.dev/fatzebra/apis/gateway.md) - [All operations](https://skmtc.dev/fatzebra/apis/gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/fatzebra/apis/gateway/revisions/a62ddbae3800?raw)