Links

Webhooks

Under Webhooks you can find your installed webhooks and add new ones.
A webhook enables web-based notifications to be sent to other applications. For example, transactions and their status can be synchronized with third-party systems such as an e-commerce store, an ERP or an accounting system.

Setup

No webhook setup is necessary for your e-commerce connection. If set up according to instructions, a hidden webhook is already created in the background.

Configuration

Currently, there are three different webhook types. These are Transaction, Subscription and Payout webhooks and are triggered as follows:
  • Transaction: Always when creating or changing the status of a transaction
  • Subscription: For important events of Payrexx managed subscriptions
  • Payout: When creating a new payout from Payrexx.
In addition, some configuration options, are available. Briefly explained here:
  • Name: Naming of the webhook. This is optional and helps for example with the assignment of the webhook logs
  • Webhook URL: The webhook data is sent to this URL. This URL must be exactly right!
  • Try again if an error occurs: There is a possibility that the webhook or its content at the destination URL will trigger an error. With this option setting, the webhook is retransmitted several times in case of an error. We recommend not enabling this option unless required by the target system.
  • Webhook Content Type: There are various formats that are used in the communication between applications. Payrexx offers the choice between JSON and POST Form Data.

Webhook Error

A Webhook error occurs when the target system rejects the request or the processing of the Webhook triggers an error in the target system. Basically, a webhook error originates with the target system. Sometimes, however, the problem is also due to an incorrect webhook URL or the wrong data type.

Procedure

Depending on the context in which you use webhooks, there are different ways to solve your webhook errors. Below we describe the procedure in three use cases.
  1. 1.
    Carefully read the documentation for setting up the respective system again. Specifically, check the chapter "Configuration - Payrexx".
  2. 2.
    Make sure that the store URL has been entered correctly. Even small spelling mistakes can lead to a problem. The most common cause is that there is a "www" in the configuration, while the store was configured without a "www" or vice versa.
  3. 3.
    If you cannot find any errors, create a new ticket with the following information:
    • Your Payrexx instance name (account name).
    • Store URL
    • Access to the administration of your third party system
    • Information whether general or sporadic problem
  1. 1.
    Carefully read the documentation for setting up the respective system again. This documentation is provided and maintained by the vendor.
  2. 2.
    Make sure that the store URL is specified correctly. Even minor typos can cause a problem. The most common cause is that there is a "www" in the configuration while the store was configured without a "www" or vice versa.
  3. 3.
    If you cannot find an error, contact the developers of the respective plugin.
If you have created your own webhooks, we assume you have some technical understanding.
Please check the webhook logs to find more information about the error. In the webhooks logs you will find an HTTP response status and a response body. Both of them can contain important information.
Troubleshooting HTTP Response Status:
  • HTTP 301 (The webhook destination is performing a redirect). Most likely the webhook URL is not correct.
  • HTTP 403 (The webhook destination does not allow the request). For example, to allow webhook requests, you can whitelist the IP of the webhook (52.29.45.62). If you need help, contact your server service provider.
  • HTTP 500 (error processing the data). Your server accepts the webhook and processes the data, but fails to do so. Check the logs in your system for additional information. This can also be triggered by an incorrect format (JSON/Post Form Data).
If your Webhook error could not be solved, we will be happy to help you within a support ticket.

Logs

In the webhook logs, you will find all webhooks that were sent from your Payrexx account. The logs contain successful as well as failed webhooks.

Developers & Webhooks

Additional information about webhooks, can be found in the corresponding article of the developer documentation: