Overview

This article provides a step-by-step guide on creating an integration between AdvocateHub and CoffeeSender using Zapier. The goal is to automate the process of sending a $5 coffee card to advocates when they complete a challenge. The article includes prerequisites, detailed instructions for setting up the challenge and configuring the webhook, and testing the integration.

 

Information

Below are the steps to set up the integration between AdvocateHub and CoffeeSender using Zapier, including prerequisites and testing instructions.

• Prerequisites
• Creating the Challenge
• Configuring the Webhook and Creating the Zap
• Testing the Integration

 

Prerequisites

Before setting up the integration, ensure you have the following:

• A Zapier account
• A CoffeeSender account.
• A CoffeeSender API Partner Key (contact CoffeeSender if you need one)
• A CoffeeSender User Key (contact CoffeeSender if you need one)
• The ID of the CoffeeSender template you wish to use ( learn how to get it here, or contact CoffeeSender for help)

 

Creating the Challenge

Create a generic challenge in AdvocateHub with the following steps:

1. Go to the Challenges page and click Add a Challenge.
2. Click on the Blank Challenge button.
3. Click on +Add Stage and add an "Advocate Workflow" stage.
4. Configure your stage and the rest of your challenge, then save and publish.

Suggestions for the challenge configuration include using the merge field {{contact.email}} to indicate the email address where the coffee will be sent and targeting the challenge to a single test advocate for testing purposes.

 

Configuring the Webhook and Creating the Zap

Set up the webhook and create the Zap in Zapier with the following steps:

1. Start a new Zap in Zapier.
2. For the Trigger, choose "Webhooks by Zapier > Catch Hook".
3. Copy the provided URL and open your AdvocateHub in a new tab.
4. Go to Settings > System > Webhooks and click Add a Webhook.
5. Configure your Webhook with the copied URL from Zapier, set the format to Form Post, and run the webhook on Advocate Workflow events.
6. Save your webhook and return to your Zapier tab to continue to the testing step.
7. Complete the Advocate Workflow stage in your Hub and verify the test in Zapier.
8. Add a Filter in Zapier to match the challenge's headline.
9. For the Action step, choose "Webhooks by Zapier > Custom Request" and configure it with the provided code and headers.
10. Test your Zap and then save and turn it on if all is well.

 

Testing the Integration

To test the integration, complete the challenge in Advocate View in your Hub. You should receive an email from CoffeeSender within a few minutes.

 

FAQ

What is the purpose of the CoffeeSender integration?

The integration aims to automatically send a $5 coffee card to advocates when they complete a challenge in AdvocateHub.

How can I obtain a CoffeeSender API Partner Key or User Key?

You need to contact CoffeeSender directly to obtain an API Partner Key or User Key for the integration.

What should I do if the Zapier test for the webhook is not successful?

Ensure that you have completed the Advocate Workflow stage in your Hub and that all webhook configurations are correct. If issues persist, consult Zapier's support documentation or contact their support team.