Sign in
Webhooks

Create new webhook

post/v1/webhook

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

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

  • c08d1ac8dcab1See the full diff
    • ▲

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

      request-property-min-length-increased

  • 985d887f3aff11See the full diff
    • ▲

      added the new required request property gateway_account_id

      new-required-request-property

    • ○

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

      response-optional-property-added

  • f2c3e257ae9d22See the full diff
    • ●

      added the new card_payment_expired enum value to the subscriptions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new card_payment_failed enum value to the subscriptions/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new card_payment_expired enum value to the request property subscriptions/items/

      request-property-enum-value-added

    • ○

      added the new card_payment_failed enum value to the request property subscriptions/items/

      request-property-enum-value-added