VEvelopaymentsapi
Webhooks

Create Webhook

Changed on

Create Webhook

post/v1/webhooks

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

Request body

payorIdstring uuid required
webhookUrlstring required

the webhook URL to use.

authorizationHeaderstring

the authorization header to include with the notification.

enabledboolean required

whether the webhook is enabled.

categoriesCategory[]

the categories to enable.

Example request

{
  "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "authorizationHeader": "authorizationHeader",
  "categories": [
    null,
    null
  ],
  "webhookUrl": "webhookUrl",
  "enabled": true
}

Response

Webhook Created

Changes

  • b924ba134e09Revision changes
    • info

      added the new funding enum value to the request property /

  • dd71433847a6Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated