How do I set up the IEX Platform REST API?

With the IEX Platform REST API, you can integrate any product that supports a webhook.

Generating an API KEY:

Setting up the REST API is very easy! First, you have to get your API credentials. Go to your IEX Platform and on the dashboard, click on "Integration Options". On the API Key section, you can generate a new key or copy the existing one. 

REST API setup details: 

1. URL: https://us-central1-bluebird-prod-fc31a.cloudfunctions.net/CreateEngagementWebhook

2. Call and response are in JSON

3. Authentication: use the headers "x-api-key" and "x-user-email". The API key is the one we just got and use the email associated to that key. Every user has a different key.

4. URL Parameters (all required): 

   • "sender_email" (string): it can be yours or you can send it on someone else's behalf if you're an admin

   • "receiver_email" (string)

   • "receiver_first_name" (string)

   • "receiver_last_name" (string)

   • "campaign_ids" (string[]): an array of campaign ids

Even if it's just one, pass in an array of one. You can see a campaign ID by going to the portal and Assets Manager->Campaigns->Click on a campaign -> Edit campaign. The id will be in the URL

If the call is successful, we will return a 201 with the following JSON values:

"order_id"

"delayed_shipping_url": 

If it's a physical campaign, we will return the URL for the user to input their address and pick a gift (if needed).

"digital_gift_urls":

If it's a digital gift, then it will be the redemption link.

Need help? support@imprintengine.com