Coordinate object

Most payloads delivered to and from the Automation Framework require a coordinate object.

If you want your bot to respond to a webhook event, simply use the coordinate from that event object. Do not alter the coordinate you receive. When calling an endpoint asynchronously, either use a coordinate you have stored or construct it manually.

{  
  ... 
"coordinate":{  
    "companyKey":"<company-key>",
    "networkKey":"<network-key>",
    "externalId":"<external-id>",
    "botId":"<registered-bot-id>",
    "normalizedAuthorId":"<author-id>"
    "messageId":"<network-message-id>",
    "scope":"PRIVATE",
    "parentId":"<network-message-parent-id>"
  },
  ...
}

Field	Description
companyKey	Your company key as defined in Response
networkKey	The source channel as defined during bot registration with Khoros
externalId	The external ID of the source channel integrated with Khoros
botId	The internal ID of the bot as registered with Khoros. This is equivalent to the bot registration `appId` field.
normalizedAuthorId	An identifier for the author of the reply or comment within the source channel.
messageId	The ID of the message generated by the external network
scope	The scope represents whether the content described by this coordinate is private or public. Possible values are PRIVATE or PUBLIC. Required.
parentId	The ID of the parent message being replied to or commented on. This is used with networks that display messages in a hierarchical format. For most messages, the Coordinate object will not have `parentId` set.
topLevelId	The ID of the top-level message in the hierarchy of the message described by the coordinate. Used with networks that display messages in a hierarchical format.

📘
Note
For Facebook, if you want the bot to respond to a comment as a sub-comment, modify the coordinate object you receive so that the messageId you receive is passed as parentId in the /respond call.

📘Note

📘
Note