Skip to content

Inkit

Inkit enables you to reach and communicate with your customers by delivering automated and personalized direct mail campaigns, rendering paperless documents at scale, and validating customer mailing addresses.

The Braze and Inkit integration allows you to send Inkit mail to Braze users through Braze webhooks.

Prerequisites

Requirement Description
Inkit account An Inkit account is required to take advantage of this partnership.
Inkit API key

<INKIT_API_TOKEN>
This key is found on your Inkit Dashboard will enable you to connect your Braze and Inkit accounts.
Inkit template ID

<INKIT_TEMPLATE_ID>
This key is found within the URL for each template, enabling you to send your template to Braze.

For example, within the URL https://app.inkit.io/#/templates/design/bd9b0b8c-c47b-40ae-8787-80dd76f6d2bb, the Template ID is bd9b0b8c-c47b-40ae-8787-80dd76f6d2bb.
HTTP header Found on your Inkit account, you will combine this with your Inkit API Key to authorize the connection as a key-value pair within your Braze template.

Integration

Step 1: Create an Inkit template

On the Inkit platform, create a template to be used in your Braze campaign. Check out Inkit documentation on this partnership to learn more.

Step 2: Create your Braze webhook template

To create an Inkit webhook template to use in future campaigns or Canvases, navigate to the Templates & Media section in the Braze platform. If you would like to create a one-off Inkit webhook campaign or use an existing template, select Webhook in Braze when creating a new campaign.

A selection of available predesigned webhook templates in the Webhook Templates tab of the Templates & Media section.

Once you have selected the Inkit webhook template, you should see the following:

  • Webhook URL: https://internal.inkit.io/integrations/webhook
  • Request Body: Raw Text

Request body code and webhook URL shown in the Braze webhook builder compose tab.

Request headers and method

Inkit requires an HTTP Header for authorization that includes your Inkit API key encoded in base 64. The following will already be included within the template as a key-value pair, but in the Settings tab, you must replace the <INKIT_API_TOKEN> with your Inkit API key.

  • HTTP Method: POST
  • Request Header:
    • Authorization: Basic {{ '<INKIT_API_TOKEN>' | base64_encode }}
    • Request Body: application/json

Request body

Ensure that your Liquid matches the proper custom attributes associated with the following required and optional fields. You can also add custom data fields to any request.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "api_token": "<INKIT_API_TOKEN>",
  "template_id": "<INKIT_TEMPLATE_ID>",
  "first_name": "{{${first_name}}}",
  "last_name": "{{${last_name}}}",
  "email": "{{${email_address}}}",
  "company": "{{custom_attribute.${company_name}}}",
  "phone" : "{{${phone_number}}}",
  "address_line_1": "{{custom_attribute.${address}}}",
  "address_line_2": "{{custom_attribute.${address2}}}",
  "address_city": "{{${city}}}",
  "address_state": "{{custom_attribute.${state}}}",
  "address_zip": "{{custom_attribute.${zip}}}",
  "address_country": "{{${country}}}",
  "source" : "Braze"
}

Step 3: Preview your request

Your raw text will automatically highlight if it is an applicable Braze tag. street, unit, state, and zip must be set up as custom attributes to send this Webhook.

Preview your request in the Preview panel or navigate to the Test tab, where you can select a random user, an existing user, or customize your own to test your webhook.

WAS THIS PAGE HELPFUL?
New Stuff!