Step 1: Get your Freshdesk API Token

Follow the steps provided in How to find your API key. Click on your profile picture on the top right and select 'Profile Settings'. Your API key will be displayed in the sidebar on the right.

Make a note of this API Key as you will need this to configure the payload inside Connector Campaign.

Step 2: Create a connector campaign on MoEngage 

To create a connector campaign on MoEngage, 

1. Navigate to Create Campaign >> Connectors >> Custom and choose the delivery type most suitable to your needs

2. On step 2 of the campaign 

• Select the method as POST
• Add Webhook URL as:

  https://<your-domain>.freshdesk.com/api/v2/tickets

• In Headers, add
  • Authorization:

    Basic {{ '<api_token>:X' | base64encode }}

  • Content-Type:

    application/json

    
    
• In the Body, you need to define the ticket details like type, subject, and status. Ticket details are extensible and can be customized based on the Freshdesk API. Use the following example to help structure your payload and enter your desired fields. 

{
    "description": "<description>",
    "subject": "<subject>",
    "email": "{{UserAttribute['Email (Standard)']}}",
    "priority": 1,
    "status": 2,
    "cc_emails": [
        "ram@freshdesk.com",
        "diana@freshdesk.com"
    ],
    "custom_fields": {
        "cf_customer_plan": "Enterprise"
    }
}

Step 3: Preview your request 

3. At this point, your campaign should be ready to test and send. You can also test your connector configuration using the Test functionality available in Step 2 of Create Connector Campaign.

You can also check your Freshdesk. If the ticket is successfully created, your set-up is good to go. You can go ahead and Publish the campaign.

Common identifier

If you have a common identifier between MoEngage and Freshdesk, it is recommended to utilize this as the requester_id, this will help unify the two sets of users.

Alternatively, if this is not the case, we recommend passing a set of identifying attributes such as name, email address, phone number, or others.

With this integration, you can:

1. Create or update Freshdesk contacts in MoEngage
2. Add or remove Freshdesk contacts to custom segments in MoEngage

A. Import Freshdesk Contacts to MoEngage

Note: This workflow makes use of the Create or Update User Action.

Step 1: Select Freshdesk as the Trigger app

1. Select Freshdesk from the list of apps.
2. Choose the "Event" as "New Contact". Click continue.
3. Connect your Freshdesk account. Select your Freshdesk account from the dropdown and click continue. 

4. Fill up the next steps. Click continue once satisfied.
5. Click "Test trigger" and Zapier will try to fetch a recent Contact. Click on continue to move to the next step.

Step 2: Select MoEngage as the Action app

Search for "MoEngage" from the apps and select it.

1. From the event dropdown, select: "Create or Update User". Click continue.
2. Following the prerequisites, you should see your MoEngage account already listed. You can either choose that or connect a new one. Click continue once done.
3. In the next step, "Set up action", you will see a list of attributes and user properties for you to either fill in or map from the previous step. Click here to know more. You can add the relevant custom user attributes as per your requirements.
4. Once you are satisfied with your mappings, click on "Continue".
5. In the final step, click on "Test & continue".
6. If the API call was successful, you should see a "success" return.

You can also verify this in your MoEngage dashboard. Go to your Freshdesk user's profile and look under custom attributes:

You can now send campaigns by filtering users that have relevant user attributes.

B. Add Contacts to a Custom Segment in MoEngage

Note: This workflow uses the Add or Remove User from Cohort (Audience) Action.

Step 1: Select Freshdesk as the Trigger app

1. Select Freshdesk from the list of apps.
2. Choose the "Event" as "Update Ticket". Click continue.
3. Connect your Freshdesk account. Select your Freshdesk account from the dropdown and click continue. 

4. Fill up the next steps. Click continue once satisfied.
5. Click "Test trigger" and Zapier will try to fetch a recent Contact. Click on continue to move to the next step.

Step 2: Select MoEngage as the Action app

Search for "MoEngage" from the apps and select it.

1. From the event dropdown, select: "Add or Remove User From Cohort (Audience)". Click continue.
2. If you have followed the prerequisites, you should see your MoEngage account already listed. You can either choose that or connect a new one. Click continue once done.
3. In the next step "Set up action", you will see a form for you to either fill in or map from the previous step. Click here to know more.
4. Select if you want to add or remove a user. Fill in all the mandatory fields and you will then be presented with an option to test this setup. Do make sure you fill in at least one of "User ID" or "Anonymous ID". To know more, read the Cohort API docs.
5. Once you are satisfied with your mapping, click continue.
6. You will now be presented with an option to test this setup.
7. Click on "Test & continue" to test this setup.
8. If the API call was successful, you should see a "success" return.

You can also verify this in your MoEngage dashboard. Go to your MoEngage Dashboard >> Segment >> Create segment. Filter users by "Custom Segment", and you should see your newly created cohort here.

This confirms that your Zap was successful.