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

# Create new webhook

`POST /v1/webhook`

## Request body

- CreateWebhookRequest
  - `callback_url` string, required
  - `description` string
  - `gateway_account_id` string, required
  - `live` boolean, required
  - `service_id` string, required
  - `subscriptions` string[]

## Response `200`

OK

- WebhookResponse
  - `callback_url` string
  - `created_date` string, date-time
  - `description` string
  - `external_id` string
  - `gateway_account_id` string
  - `live` boolean
  - `service_id` string
  - `status` 'ACTIVE' | 'INACTIVE'
  - `subscriptions` string[]

## Other responses

- `400` — Invalid payload (ex: non existent event type)
- `422` — Missing required parameters

## Changes

- **2025-04-10** `c08d1ac8dcab` — 1 breaking
  - the `gateway_account_id` request property's minLength was increased from `0` to `1`
- **2023-05-18** `985d887f3aff` — 1 breaking, 1 info
  - added the new required request property `gateway_account_id`
  - added the optional property `gateway_account_id` to the response with the `200` status
- **2022-10-28** `f2c3e257ae9d` — 2 warning, 2 info
  - added the new `card_payment_expired` enum value to the `subscriptions/items/` response property for the response status `200`
  - added the new `card_payment_failed` enum value to the `subscriptions/items/` response property for the response status `200`
  - added the new `card_payment_expired` enum value to the request property `subscriptions/items/`
  - added the new `card_payment_failed` enum value to the request property `subscriptions/items/`

[Change history](https://skmtc.dev/government-digital-service/apis/webhooks-api/changes/v1/webhook/post.md)

---

[API](https://skmtc.dev/government-digital-service/apis/webhooks-api.md) · [All operations](https://skmtc.dev/government-digital-service/apis/webhooks-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/government-digital-service/webhooks-api/revisions/c08d1ac8dcab/schema)