GOgovernment-digital-service
Webhooks

List webhooks for a service external ID or all webhooks

Changed on
get/v1/webhook

Request

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

Query parameters

liveboolean required

Set to true to return live webhooks for service.

service_idstring

Service external ID. Required when override_service_id_restriction is not true

gateway_account_idstring

Gateway account ID. Required when override_service_id_restriction is not true

override_service_id_restrictionboolean

Set to true to list all webhooks. if 'true', service_id is not permitted

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