Join Event

This event object is used when a bot joins a team/group or 1:N message room.
It occurs in the following cases, where an event object whose type property is "join" is sent.

  • When a bot creates a message room using the API
  • When a bot is invited to a team/group or 1:N message room
  • When a user creates a message room with a bot included.

Request {#join-event-request}

ParameterTypeRequiredDescription
typestringYSet this parameter to "join".
sourceobjectYThe subject that sent a callback message.
source.channelIdstringYThe message room ID to which the bot was invited.
source.domainIdnumberYThe domain ID to which the bot was invited.
issuedTimestringYThe date and time when the event occurred, in RFC 3339 format.

Request example {#join-event-request-example}

POST /callback HTTP/1.1Host: YOUR_SERVER_HOST_NAMEContent-type: application/json; charset=UTF-8X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=X-WORKS-BotId: 123{  "type": "join",  "source": {    "channelId": "12345",    "domainId": 40029600  },  "issuedTime":"2022-01-04T05:16:05Z"}

Response (customer's server receiving messages -> message server) {#join-event-response}

It should return HTTP status 200 if successful.
The HTTP request sent by a callback is not resent even if it failed.

Response {#join-event-response-example}

HTTP/1.1 200 OKContent-Type: application/jsonServer: YOUR_SERVER_HOST_NAMEContent-Length: 0