FinText™ Platform: Inbound Message Webhook Fields

Difference between "OriginalMessage" and "Message" fields

Please refer to SBT’s Redoc API documentation for more information on the Inbound Message Webhook, its uses, and structure.

OriginalMessage versus Message

In short, the difference between the two fields is as follows:

  • OriginalMessage shows the full text of the messages received from the subscriber/consumer.
  • Message shows either of the following:
    • A reserved word or keyword leading the message.
    • If there is no keyword at the start, the full text of the message.

Typically, the content of the fields is the same. However, if the subscriber/consumer sends a reserved word, the Message field shows the operation performed.

Also, the full message text may have value to SBT customers beyond the reserved word or keyword. The OriginalMessage field provides the full text for further use by the customer.

Background

The Inbound Message Webhook alerts SBT customers when inbound messages from consumers are received by the SBT FinText™ platform. The platform will recognize reserved words and keywords in the first word or words of those inbound messages and act on the reserved/keywords.

Examples

The following examples show the following:

  • MessageType: The category of the inbound message.
  • OriginalMessage: The message received from the subscriber/consumer.
  • Message: How the FinText platform interprets the reserved/keyword.
Inbound Message Webhook Output
Field Value
STOP

MessageType

ReservedKeyword

OriginalMessage

STOP

Message

STOP

 STOP or my mom will shoot! 

MessageType

ReservedKeyword

OriginalMessage

STOP or my mom will shoot!

Message

STOP

 Halt who goes there? 

MessageType

ReservedKeyword

OriginalMessage

HALT who goes there

Message

STOP

 How do I make a payment? 

MessageType

TwoWay

OriginalMessage

How do I make a payment?

Message

How do I make a payment?