Leave Event

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

  • When a bot leaves the message room using the API
  • When a bot is forcibly removed from the message room
  • When the team/group or 1:N message room is deleted

Note

  • If all other members except the bot leave the team/group or 1:N message room, the bot will automatically leave it.

Request {#leave-event-request}

ParameterTypeRequiredDescription
typestringYSet this parameter to "leave".
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 (format: YYYY-MM-DDThh:mm:ss.SSSZ).

Request example {#leave-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": "leave",  "source": {    "channelId": "12345",    "domainId": 40029600  },  "issuedTime":"2022-01-04T05:16:05.716Z"}

Response (customer's server receiving messages -> message server) {#leave-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 {#leave-event-response-example}

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