Create a webhook

Changed on
post/webhooks

Request

  • Base URL
    https://api.notchpay.co
  • URL
    https://api.notchpay.co/webhooks
  • Auth
    • API key in header Authorization
    • or API key in header X-Grant
    • or API key in header X-Sync

Request body

urlstring required
descriptionstring
eventsstring[] required

Example request

{
  "url": "https://example.com/webhooks",
  "description": "Webhook principal"
}

Response

Webhook endpoint created

codeinteger required
statusstring required
messagestring required
endpointWebhook required(unresolved $ref)

Changes

    • breaking

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

    • breaking

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

    • breaking

      the response's body type changed from no type to object for 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 required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status