Webhooks are notifications which get sent from the RxSpark platform to a URL you specify. Webhooks are useful for receiving notifications when there is an event that takes place with your account or one of your referred users. For instance, you might receive a webhook when a new user signs up under your partner account. This would carry a payload of data including things like the customer's email address and RxSpark member ID which you could use in subsequent API calls.

To register a webhook, navigate to your Partner Portal, then to Advanced Settings.

Look through the options to find a setting called "Webhook URL" and fill out the URL you'd like us to send notifications to. This URL must be secured with an SSL certificate and must begin with https://
​

Once you have saved your Webhook URL, we will start sending notifications as they occur.

For information on available webhooks and sample requests, please see our Webhook Documentation.