How to set up trigger webhooks

Triggers let you perform actions when certain events happen in the platform. You could use triggers to automate the approval of affiliates, commissions, or generation of payouts, for example. Please note that webhooks are an advanced feature - we highly advise that you fetch a developer to help implement this.

The triggers feature can be found by following the ‘Settings’ gear icon in the dashboard.

Events

We have several events implemented which you can set triggers to, some of them are:

  • Affiliate created: This can be the result of an individual (who was previously not an affiliate) signing up as an affiliate, or being manually added as an affiliate. You can distinguish who initiated this event by using the ‘initiator’ filter.

  • Affiliate added to program: Each time an affiliate applies, or is manually added to a program. You can distinguish who initiated this event by using the ‘initiator’ filter.

  • Affiliate approved for program: This event is triggered when an affiliate is automatically approved, or manually added to a program.

  • Conversion created: This event is triggered whenever a conversion is created.

  • Commission created: This event is triggered whenever a commission is created. This can be the result of a conversion, an automatic recurring commission, an MLM commission, or a commission added through the API.

  • Commission updated: This event is triggered whenever a commission is (dis)approved or edited.

  • Payout created: This event is triggered each time a payout is created.

  • Payout updated: This event is triggered each time a payout is updated (e.g. marked as ‘paid’)

Filters

You can assign filters to triggered events, too. The filters are different for each specific event. For example, the event ‘affiliate created’ has the filters options shown in the image below:

TriggerFiltersOptions

Setting up a new trigger webhook

  1. Access the trigger feature from the ‘Settings’ gear icon in the dashboard.

  2. Select the ‘event’ that will trigger the email.

  3. Add filters (optional).

  4. Choose from the right-hand ‘Add action’ column, the ‘Webhook’ action.

  5. Open the Webhook settings.

  6. Depending on the type of action you want to trigger, use the correspondent endpoint from our REST API and place it in the URL field.

  7. Use merge tags as indicated in the API documentation for the endpoint.

  8. Write ‘Api-Key’ in the ‘header’ field.

  9. Copy the API key from the account settings: Click on the profile icon on the top-right corner > Click on ‘Account settings’ > Tab ‘Api access’ > Click on ‘Generate’> Copy the key.

  10. Paste the key in the header ‘value’ field.

  11. Hit ‘Save’.