# AgentLaunchEvent

An event that occurred when an agent's launch status is changed.

The AgentLaunchEvent appears in the "data" field of the "message" object that the agent receives from its Pub/Sub subscription. The "data" field is a base64-encoded string that the agent must decode to match the PartnerEvent structure.

| JSON representation |
|---|
| ``` { "eventId": string, "agentId": string, "botDisplayName": string, "brandId": string, "brandDisplayName": string, "regionId": string, "oldLaunchState": enum (`https://developers.google.com/business-communications/rcs-business-messaging/reference/rest/v1/AgentLaunchEvent.LaunchState`), "newLaunchState": enum (`https://developers.google.com/business-communications/rcs-business-messaging/reference/rest/v1/AgentLaunchEvent.LaunchState`), "actingParty": string, "comment": string, "sendTime": string } ``` |

| Fields ||
|---|---|
| `eventId` | `string` A unique event ID assigned for the event instance. |
| `agentId` | `string` The agent's unique identifier. Set by RCS for Business. |
| `botDisplayName` | `string` The agent's display name. |
| `brandId` | `string` The brand's unique identifier. |
| `brandDisplayName` | `string` The brand's display name. |
| `regionId` | `string` The identifier for the region where the agent's launch is changed. Format: "/v1/regions/{regionId}". For example, "/v1/regions/fi-rcs". |
| `oldLaunchState` | ``enum (`https://developers.google.com/business-communications/rcs-business-messaging/reference/rest/v1/AgentLaunchEvent.LaunchState`)`` Output only. New type of the launch state. |
| `newLaunchState` | ``enum (`https://developers.google.com/business-communications/rcs-business-messaging/reference/rest/v1/AgentLaunchEvent.LaunchState`)`` Output only. Current type of the launch state. |
| `actingParty` | `string` Acting party. |
| `comment` | `string` Change comment. |
| `sendTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Time at which the server sends the event. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |