GOgovernment-digital-service
Webhooks

Create new webhook

Changed on
post/v1/webhook

Request

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

Request body

callback_urlstring required
descriptionstring
gateway_account_idstring required
liveboolean required
service_idstring required
subscriptionsstring[]

Example request

{
  "callback_url": "https://example.com",
  "description": "Webhook description",
  "gateway_account_id": "100",
  "service_id": "eo29upsdkjlk3jpwjj2dfn12",
  "subscriptions": [
    "card_payment_started"
  ]
}

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

  • c08d1ac8dcabRevision changes
    • breaking

      the request property's minLength was increased from 0 to 1

  • 985d887f3affRevision changes
    • breaking

      added the new required request property

    • info

      added the optional property to the response with the status