GOgovernment-digital-service
Webhooks

Update webhook

Changed on

Allows patching description, callback_url, status, subscriptions

patch/v1/webhook/{webhookExternalId}

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

webhookExternalIdstring required

Query parameters

service_idstring required
gateway_account_idstring required

Request body

JsonNode[] required

Example request

[
  {
    "path": "description",
    "op": "replace",
    "value": "new description"
  }
]

Response

OK

callback_urlstring
created_datestring date-time
descriptionstring
external_idstring
gateway_account_idstring
liveboolean
service_idstring
status'ACTIVE' | 'INACTIVE'
subscriptionsstring[]

Example response

{
  "callback_url": "https://example.com",
  "created_date": "2022-04-05T17:07:15.281Z",
  "description": "Webhook description",
  "external_id": "gh0d0923jpsjdf0923jojlsfgkw3seg",
  "gateway_account_id": "100",
  "service_id": "eo29upsdkjlk3jpwjj2dfn12",
  "status": "ACTIVE",
  "subscriptions": [
    "card_payment_started"
  ]
}

Changes