Skip to main content

Input fields

accountNumber : String

The number of the Kraken account that the message was from.

channel : InkCommunicationChannel! required

The channel type the posted message should be treated as in Ink.

It is used to determine how the message should be processed and what channel-specific features are available for this message.

messageHeaders : JSONString

An optional parameter where we can pass the generic message headers if it has one

Email channel tries to get the value conversation-relay-id from this parameter

messageId : String! required

An arbitrary, unique ID for this message.

This must be unique for each message that is supplied using the same organisation; collisions between messages provided by different organisations are tolerated.

Stored as vendor_id.

newMessage : InkMessageInput! required

The message to ingest.

occurredAt : DateTime

When the message occurred in the system of origin.

vendor : String

An optional vendor value to denote which system it originated from.

If no vendor is passed, we will get the default generic vendor from the setting called INK_DEFAULT_GENERIC_MESSAGE_API_VENDOR.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "accountNumber": "A-08672A65", "channel": "EMAIL", "messageHeaders": {"key": "value"}, "messageId": "33911541", "newMessage": InkMessageInput, "occurredAt": "1986-11-30T17:46:19.729266+00:00", "vendor": "Mr-any-television-easy-sing" }