Making a Request

The Webhook URL is the only URL you will be using to communicate with ChatBeacon. From this one endpoint you will be able to start a session, request a chat, and respond to chat segments. The body of your POST request must contain at least 1 unique, identifying property and may include optional text you wish to send as the first segment of the visitor. The JSON object is represented below:

export class ChatBeaconObj{
    	text:string;
    	sessionId:string;
    	visitorId:string;
    	userId:string;
    	facebookId:string;
    	phone:string;
    }

public class PostObject {

    	[JsonProperty("text")]
    	string Text { get; set; }

    	[JsonProperty("sessionId")]
    	Guid SessionId { get; set; }

    	[JsonProperty("visitorId")]
    	Guid VisitorId { get; set; }

    	[JsonProperty("userId")]
    	string UserId { get; set; }

    	[JsonProperty("facebookId")]
    	string FacebookId { get; set; }

    	[JsonProperty("phone")]
    	string Phone { get; set; }
    }

text
The 'text' property allows you to post input from the visitor to the ChatBeacon chat

sessionId
The 'sessionId' is a unique GUID issued by the ChatBeacon server. It identifies a specific session of the visitor.

visitorId
The 'visitorId' is a unique GUID issued by the ChatBeacon server. It identifies a visitor. A visitor can have multiple live sessions in ChatBeacon, but only 1 concurrent chat

userId
The 'userId' is a unique ID issued by you. This value will become part of the visitors ChatBeacon profile. ChatBeacon will query stored visitor profiles for this value and start a session based on the first profile it matches

facebookId
The 'facebookId' property is the userId issued by Facebook. This value will become part of the visitors ChatBeacon profile. ChatBeacon will query stored visitor profiles for this value and start a session based on the first profile it matches

phone
The 'phone' property is the visitors telephone number. This value will become part of the visitors ChatBeacon profile. ChatBeacon will query stored visitor profiles for this value and start a session based on the first profile it matches

The response to your POST request will be an object containing the visitor's visitorId, sessionId, and chatId. The chatId is the id of the visitors currently active chat:

Test Your ChatBeacon Webhook
Webhook URL

{
    	visitorId: "00000000-0000-0000-0000-000000000000",
    	sessionId: "00000000-0000-0000-0000-000000000000",
    	chatId: 00
    }