Connecting Kustomer to Y Meadows

Setting up Kustomer as A Message Source

Go to Settings and select Security > API Keys.

Select Add API Key.

A popup will appear to edit your new API key. Name the API key Y Meadows.

Under Roles, select the following:

org.permission.attachment.read org.permission.apps.read org.admin.klass.read org.admin.metadata org.permission.company org.permission.conversation org.permission.customer org.permission.draft org.permission.klass.read org.permission.kobject.kobject_*.read org.permission.kobject.read org.permission.message org.permission.metadata org.permission.note org.permission.queue org.permission.routing org.permission.team org.permission.user org.user.klass.read org.user.kobject.read org.user.metadata org.user.routing

In the Expires menu, select 365 days.

Click Create to finish creating the new key.

On the confirmation screen, you'll be shown your new key. For security reasons, this is your one and only chance to copy the key. Select Copy Token to copy the hash to your clipboard. Please save it, you will need it in a future step.

Step 2 - Set up message source on Y Meadows side

Create a new connection based on Kustomer Event Webhook connection type.

Enter API Key from Step 1

Enter any value as Kustomer Secret (e.g. my-secret), you will update it later

By default we will process only first message from conversation.

If you are interested into conversation event processing - no need to check any checkbox

Check Process all IN messages if you want to process all IN messages

Check Process all messages if you want to process all (in and out) messages

Enter JSON path to map Subject, Body, Sender Name and Sender Email to override default mappings, all are optional.

Can use GitHub - json-path/JsonPath: Java JsonPath implementation to get list of available operators, functions and filter operators.

Save the new connection

Take a look at the URL in the browser. It will be something like https://{SUBDOMAIN}.ymeadows.com/components/connections/d5b87007-8304-4df8-b0d7-bafe4b98b4b6 . That last portion, d5b87007-8304-4df8-b0d7-bafe4b98b4b6 is the Connection ID. Please save it, you will need it in a future step.

Step 3 - Kustomer Outbound Webhook Setup

This must be done by a Kustomer Admins or Org Owners.

Kustomer only allows 5 user created outbound webhooks. If the user already has 5 they must delete one to do this.

Go to Settings and select Platform > Outbound Webhooks.

Select Add Outbound Webhook.

Open image-20230517-163356.png

Enter Y Meadows as the name for the webhook.

Enter https://{SUBDOMAIN}.ymeadows.com/api/v1/webhooks/kustomer/{CONNECTION_ID} where CONNECTION_ID is ID of the connection from Step 2.

Under Webhook Trigger Events choose kustomer.message.create if you are interested in message events, kustomer.conversation.create if you are interested in conversation creation events and kustomer.conversation.update if you are interested in conversation end events.

Save outbound webhook

TURN THE WEBHOOK OFF!

The Kustomer platform will kill a webhook if it has 10 failed attempts in a row. So, turn the webhook off until the rest of the work in this instruction set is completed!

Edit created outbound webhook and copy Kustomer Secret. Please save it, you will need it in a future step.

Step 4 - Update Kustomer Secret in YMeadows connection

Go back to connection created on Step 2 and set Kustomer Secret from Step 3 as Kustomer Secret

Step 5 - Enable Outbound Webhook on Kustomer side

Go back to Outbound Webhook created on Step 3 and enable it.