You can connect any service to Inkit and send mail using our general webhook.
The steps to get the webhook up and running are as follows:
- Find your API key and Template ID from the Inkit dashboard. Your API key is located here. The Template ID can be found within the URL for each template- for example: https://app.inkit.io/#/templates/design/bd9b0b8c-c47b-40ae-8787-80dd76f6d2bb
- In the tool or app you want to connect to Inkit, create a new webhook. The details of creating new webhooks vary between platforms. Reach out to your platform's support team to find out how to create a new webhook.
- Fill in the webhook with the following details:
Add a HTTP Header for the Authorization key value pair, with your API key from Inkit.
Add the following mandatory fields to specify the recipient, using built-in and custom properties in your platform, and the template which should be sent out:
User Profile Fields
api_token (Your Inkit API key)
template_id (Template ID from Inkit’s end)
state (must be a 2 character code, e.g. CA)
country (must be a 2 character code, e.g. US)
Custom Data Fields
Custom data fields can be added into any request. Simply add the field name into the request and we'll add that key: value pair into that contact.
Example Webhook Request:
"company": "Pied Piper",
"email": "[email protected]",
"street": "101 Unicorn Lane",
"city": "San Francisco",
As you can see,
likes are extra fields added into the request. These fields can be used on your templates to dynamically deliver customized direct mail to your customers.
And that’s it! Now you’re ready to start automating direct mail through your connected platform based on any actions or events you like.