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.

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.

  • Affiliate disapproved for program: This event is triggered when an affiliate is disapproved for a program.

  • Affiliate prospect created: This event is triggered when an affiliate prospect is created by an affiliate recruitment source.

  • Affiliate prospect promoted: This event is triggered when an affiliate prospect becomes an affiliate. There are several ways for a prospect to be promoted.

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

  • Affiliate added to group: This event is triggered when an affiliate is added to an affiliate group.

  • 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.

  • Payment created: This event is triggered when an affiliate’s balance is settled in Tapfiliate.

  • Customer created: This event is triggered when a customer is created.

  • Customer updated: This event is triggered when a customer is created.

Filters

It’s possible to add filters to your event, so that your webhook fires only when the conditions set are met. The filters vary per event and are optional.

New Filters Webhooks

To see what filters are available for your chosen event, you can click on “Add Filter”.

Setting up a new trigger webhook

  1. Go to the Triggers tab on the left-hand side of your Dashboard. Push the “New trigger” button to begin.
  2. Fill out the fields, and indicate the triggering event for your webhook.
  3. Add filters (optional).

  4. Select one of our webhook options:

    • Webhook - Sends a webhook to a specific URL using the same format documented in our API doc examples.
    • Webhook (custom) - Use this option to create a customized webhook in a specific format. Read step 5 for further information.

  5. If you use the Webhook (custom) option, set your Api-Key in the header field. You can find your key in your Profile Settings. When composing your body, you can also use merge tags to fill in the data. You can find these by clicking in the {…} that pops up on the right side of the field.

  6. When you’re done, save your webhook.