---
title: "Update webhook"
method: PATCH
path: "/v1/webhook/{webhookExternalId}"
tags: ["Webhooks"]
---

# Update webhook

`PATCH /v1/webhook/{webhookExternalId}`

Allows patching `description, callback_url, status, subscriptions`

## Path parameters

- `webhookExternalId` string, required

## Query parameters

- `service_id` string, required
- `gateway_account_id` string, required

## Request body

- JsonNode[]

## 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

## Changes

- **2023-05-23** `12636419a51a` — 1 breaking
  - added the new required `query` request parameter `gateway_account_id`
- **2023-05-18** `985d887f3aff` — 1 info
  - added the optional property `gateway_account_id` to the response with the `200` status

[Change history](https://skmtc.dev/government-digital-service/apis/webhooks-api/changes/v1/webhook/:webhookExternalId/patch.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)