Table of Contents
You can automate reporting workflow with instant notifications. Webhooks offer developers and integrators a way to “subscribe” to the relevant transaction events as soon as they happen. They let you know what your merchants are doing in nearly real time, automatically. You can subscribe to be notified about failed transactions, unknown transactions, failed settlements, and many more events. With these real time notifications you can take action as needed for each specific case to improve merchant satisfaction and proactively address any issues before your merchant notifies you about the issue.
Your affiliate sub-users will need to have the 'Manage webhook configuration' and have the administrative user permission to be able to manage webhook configurations; this also applies to your Sub-Affiliate sub-users so they can manage their own webhook configurations in their portfolio. Primary users have this permission set by default and it cannot be removed.
Log in to your Partner Portal and head over to Settings → under General Settings click on Webhooks. From there, you will find a step by step guide on how to set up webhooks by clicking on the "Read the documentation" link in your Partner Portal. You can also find detailed documentation of the process in our Integration Portal under Webhooks.
Who can configure/edit Affiliate Webhooks?
You can manage who has access to changing any of the webhooks settings in your portfolio within the user permissions. The permission is called 'Manage webhook configuration'. If you want to add or remove this permission for a user, please follow the Editing and Updating Users steps.
What notifications can you get with Webhooks?
You can subscribe to the following events:
- Transaction - you can get notifications for any successful, failed, or unknown transactions (an unknown transaction would be an example of: gateway submitted a transaction to the processor and the gateway never heard back). You can choose which transaction type to get notifications on; sales, auths, captures, voids, refunds, and credits. All transaction webhooks will include all merchant defined fields that were a part of a transaction. An example can be found here.
- Recurring - you can get notifications for adding, updating, or canceling/deleting subscriptions and for adding, updating or deleting plans. An example can be found here.
- Settlement - you can get notifications on your merchants' settlements in real time. This includes notifications for failed settlements, which will enable you to act quicker than ever to sort out any funding issues merchants may be facing. An example can be found here.
- Chargebacks - you can get notifications for when a merchant has a chargeback processed on their account. Only available on processors who support chargeback reporting. The notification will include an "id", which is the Transaction ID. An example can be found here.
- Automatic Card Updater - you can get notifications for card records that have been updated, marked as closed, or for customer contact in the Customer Vault and/or recurring subscription records. An example can be found here.
When will I receive a Webhook notification?
All webhooks are queued for delivery right when their events occur and usually deliver to the destination server in milliseconds. At the time your server is either down or experiencing heavy load and cannot accept messages at that time the gateway will reattempt delivery via the Retry Logic for any webhook notification sent to your endpoint that did not get a success status response back.
Where can I find my signing key?
The signing key gets generated after you create an endpoint. An endpoint is created once you complete step 2 from Setting Up Webhooks. You will use this signing key on your website.
Are Webhooks available for Merchants?
Yes! Merchants can configure their own webhooks in their Merchant Portal. Once they log in they will need to go to Settings → under Transaction Options click on Webhooks. They can also manage who has access to changing their webhooks settings within their user's permissions. The permission is called 'Manage Webhook Configuration'.
Will other events be added to Webhooks?
We are continuously adding more features and events to the functionality of webhooks. Subscribe to our weekly release notes emails to stay up to date. To subscribe head over to your Partner Portal → on left side panel click on Release Note and check the box for "Subscribe to weekly release notes emails". You can also edit each user's notifications by heading to Settings → Users → click on the username → under Notifications check the box for "Release Notes Emails". If you don't have the Release Note section in your Partner Portal, please contact firstname.lastname@example.org.