Sign in
Webhooks

Get webhook by external ID, service ID and gateway account ID (query param)

get/v1/webhook/{webhookExternalId}

Path parameters

webhookExternalIdstring required

Query parameters

service_idstring
gateway_account_idstring
override_account_or_service_id_restrictionboolean

If false, the service_id and gateway_account_id must be specified

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

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

  • 12636419a51a1See the full diff
    • ○

      added the new optional query request parameter gateway_account_id

      new-optional-request-parameter

  • 985d887f3aff1See the full diff
    • ○

      added the optional property gateway_account_id to the response with the 200 status

      response-optional-property-added

  • 1c0d158630ce2See the full diff
    • ○

      added the new optional query request parameter override_account_or_service_id_restriction

      new-optional-request-parameter

    • ○

      the query request parameter service_id became optional

      request-parameter-became-optional