Webhooks

List webhooks for a service external ID or all webhooks

get/v1/webhook

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

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

Changed in 3 of the 13 revisions of this API.22

May 23, 202312636419a51a1See the full diff
- ○
  added the new optional query request parameter gateway_account_id
  new-optional-request-parameter
May 18, 2023985d887f3aff1See the full diff
- ○
  added the optional property items/gateway_account_id to the response with the 200 status
  response-optional-property-added
Oct 28, 2022f2c3e257ae9d2See the full diff
- ●
  added the new card_payment_expired enum value to the items/subscriptions/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new card_payment_failed enum value to the items/subscriptions/items/ response property for the response status 200
  response-property-enum-value-added

Full history