Webhooks

Webhook Endpoint:

This is an API endpoint that allows users to set up a webhook. A webhook is a way for an application to provide real-time information to another application or server over the HTTP protocol.

API Key-Based Configuration:

The webhook URL will be determined based on the API key used. This means that when you use your API key to call this endpoint, the system will automatically configure the webhook URL for your account. This ensures that each user’s webhook configuration is personalized and secure.

📘

Note: By default, when using this endpoint, the system will use event types (version 2). Event types define the kind of actions or changes in the system that the webhook should be notified about.

This Event object contains all the relevant information about what just happened, including the type of event and the data associated with that event. Paynote then sends the Event object, via an HTTP POST request, to any endpoint URLs that you have defined in your account’s Webhooks settings. Paynote supports basic access authentication, including your secret API key in the request.

To acknowledge receipt of a webhook, your endpoint should return a 2xx HTTP status code. All response codes outside this range, including 3xx codes, will indicate to Paynote that you did not receive the webhook. This does mean that a URL redirection or a "Not Modified" response will be treated as a failure.

Note: Right now, we only guarantee access to events through the Retrieve Event API for 7 days.