Messaging File
  • 13 Nov 2024
  • 1 Minute to read
  • Dark
    Light

Messaging File

  • Dark
    Light

Article summary

The Messaging File format is used to trigger a message to one or more Customers or Patients, identified by the ccid field. Each row in the .csv file identifies a single ccid and trigger_id combination.

Each row can specify a different trigger_id from a different journey.

This file format can be sent via SFTP or Uploaded manually via the File Engine Jobs section in CX Builder.

Data File Properties: Messaging

Property

Data Type

Length

Required

Description

ccid

string

100

Yes

The unique identifier of the Customer.

trigger_id

string

100

Yes

The unique Trigger identifier that was the originating source of the event.

asset_id

string

100

No

The asset_id can be used to override the default branding on the message.

input_xxx

string

100

No

Input parameters to be used in the experience. Each input parameter is prefixed with "input_" followed by the input parameter name.

  • Custom input parameters are provided by the Client.
  • Zero or more input_ parameters can be specified.
  • Different input_ parameters can be specified on each row in the file.
  • The maximum length of each input_ parameter is 100 characters.

client_message_tag

string

100

No

An optional, Client created, tag that was provided during the initial messaging/onboarding request.

lb_name

string

255

No

Launched by name. If set, identifies the name of the user that triggered the notification.

lb_source

string

255

No

Launched by source. If set, identifies the source system that triggered the notification.


Was this article helpful?

ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence