Within Zephr you have the ability to use Webhooks to send third-party applications real-time information. Webhooks allow you to integrate with products that do not have a Zephr plugin. Webhooks are commonly used to add a user to a mailing list, note in a CRM when a User hits a Paywall, or trigger automated marketing emails.
Adding a Webhook in Zephr is easy. You will need to know when you want to trigger the Webhook, as well as the Target End Point URL, which is where the information held within the Webhook should be sent.
You can also add basic authentication credentials for the webhook.
To begin, navigate to Settings > Webhooks within the Zephr Admin Console. This will take you to a list of your current Webhooks. Click Add A Webhook.
Configuring a Webhook
Given your Webhook a title, then select the Webhook Type.
System Webhooks will be triggered by System events happening within Zephr.
Rule Webhooks allow you to trigger a Webhook within a Zephr Feature Rule.
Once you have completed the Type configuration, select the Method – either GET, POST, PUT, or DELETE
For Target, enter the Endpoint Target URL for the system you are integrating with. For more information, check the help desk of the system you’re integrating with to find out how to listen for Webhooks. Note that to set up a webhook that requires basic authentication, the target endpoint must use HTTPS.
Under Credentials, select whether to add credentials for the webhook. To add credentials, first select Basic Authentication. You can either select an existing credential by entering the name of the credential in the search bar, or add a new one by clicking + Add New Credential.
Following this, click Add Sites to set which of your sites the webhook will be used on. If you haven’t set up your Zephr sites yet, take a look at our Sites guide.
Once the fields are complete, click Save.
Once added, the Webhooks you create will fire whenever the trigger criteria you have set is met within Zephr, or, if you’ve selected the Rule Webhook, can be used within your Zephr Feature Rules. Once the Webhook has been created and saved, follow our guide for adding a Webhook to a Feature Rule to learn how to trigger it.