Slack

The Slack connector lets you perform insert, delete, update, and read operations on Slack data.

Before you begin

Before using the Slack connector, do the following tasks:

  • In your Google Cloud project:
    • Ensure that network connectivity is set up. For information about network patterns, see Network connectivity.
    • Grant the roles/connectors.admin IAM role to the user configuring the connector.
    • Grant the following IAM roles to the service account that you want to use for the connector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. For more information, see Creating a service account.

    • Enable the following services:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      To understand how to enable services, see Enabling services.

    If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.

  • For information about how to create a Slack workspace, see Quickstart with Slack. For information about Slack platform, see Slack platform overview.

Configure the connector

Configuring the connector requires you to create a connection to your data source (backend system). A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following steps:

  1. In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.

    Go to the Connections page

  2. Click + CREATE NEW to open the Create Connection page.
  3. In the Location section, choose the location for the connection.
    1. Region: Select a location from the drop-down list.

      For the list of all the supported regions, see Locations.

    2. Click NEXT.
  4. In the Connection Details section, complete the following:
    1. Connector: Select Slack from the drop down list of available Connectors.
    2. Connector version: Select the Connector version from the drop down list of available versions.
    3. In the Connection Name field, enter a name for the Connection instance.

      Connection names must meet the following criteria:

      • Connection names can use letters, numbers, or hyphens.
      • Letters must be lower-case.
      • Connection names must begin with a letter and end with a letter or number.
      • Connection names cannot exceed 63 characters.
    4. Optionally, enter a Description for the connection instance.
    5. Optionally, enable Cloud logging, and then select a log level. By default, the log level is set to Error.
    6. Service Account: Select a service account that has the required roles.
    7. Optionally, configure the Connection node settings:

      • Minimum number of nodes: Enter the minimum number of connection nodes.
      • Maximum number of nodes: Enter the maximum number of connection nodes.

      A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.

    8. Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
    9. Click NEXT.
  5. In the Authentication section, enter the authentication details.
    1. Select an Authentication type and enter the relevant details.

      The following authentication types are supported by the Slack connection:

      • OAuth2.0 - Authorization Code
      • User Token Authentication

      2. To understand how to configure these authentication types, see Configure authentication.

    2. Click NEXT.
  6. Review: Review your connection and authentication details.
  7. Click Create.

Configure authentication

Enter the details based on the authentication you want to use.

  • OAuth2.0 - Authorization Code

    To authenticate using OAuth2.0, enter the following details:

    • Client ID: The client id provided by connector for the app you created.
    • Scopes: A comma-separated list of desired scope.
    • Client Secret: Secret manager secret containing the client secret for the connected app you created.
    • Secret Version: Secret version for the secret selected above.
  • User Token Authentication

    To authenticate using user token, enter the following details:

    • User Token: The user token used to authenticate the user.
    • Secret Version: Secret version for the secret selected above.

For the Authorization code authentication type, after creating the connection, you must perform a few additional steps for configuring authentication. For more information, see Additional steps after connection creation.

Additional steps after connection creation

If you selected OAuth 2.0 - Authorization code for authentication, you must do the following additional steps after creating the connection:

  1. In the Connections page, locate the newly created connection.

    Notice that the Status for the new connector will be Authorization required.

  2. Click Authorization required.

    This shows the Edit authorization pane.

  3. Copy the Redirect URI value to your external application.
  4. Verify the authorization details.
  5. Click Authorize.

    If the authorization is successful, the connection status will be set to Active in the Connections page.

Re-authorization for authorization code

If you are using Authorization code authentication type and have made any cofiguration changes in your application, you must re-authorize your Onedrive connection. To re-authorize a connection, perform the following steps:

  1. Click on the required connection in the Connections page.

    This opens the connection details page.

  2. Click Edit to edit the connection details.
  3. Verify the OAuth 2.0 - Authorization code details in the Authentication section.

    If required, make the necessary changes.

  4. Click Save. This takes you to the connection details page.
  5. Click Edit authorization in the Authentication section. This shows the Authorize pane.
  6. Click Authorize.

    If the authorization is successful, the connection status will be set to Active in the Connections page.

Connection configuration samples

This section lists the sample values for the various fields that you configure when creating the connection.

Slack - UserToken authentication connection type

Field name Details
Location us-central1
Connector Slack
Connector version 1
Connection Name slack-usertoken-connection
Enable Cloud Logging Yes
Service Account SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Verbosity Level 5
Minimum number of nodes 2
Maximum number of nodes 50
User Token Authentication Yes
User Token USER_TOKEN
Secret version 1

Slack - OAuth 2.0 authentication connection type

Field name Details
Location us-central1
Connector Slack
Connector version 1
Connection Name slack-google-cloud-oauth-conn
Enable Cloud Logging Yes
Service Account SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Verbosity Level 5
Minimum number of nodes 2
Maximum number of nodes 50
OAuth 2.0 - Authorization code Yes
Client ID CLIENT_ID
Scopes channels:read, groups:read, im:read, mpim:read, channels:write, groups:write,
im:write,mpim:write, channels:history, groups:history, im:history, mpim:history,
search:read, chat:write:user, chat:write:bot, files:read, files:write:user, pins:read,
pins:write,usergroups:read, usergroups:write, reminders:read, reminders:write,
users:read, users.profile:write
Client Secret CLIENT_SECRET
Secret version 2

System limitations

The Slack connector can process a maximum of 1 transaction per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Use the Slack connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

  • To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
  • To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

  • Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

    However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

  • Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:

    Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

  • Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Actions

This section lists the actions supported by the Slack connector. To understand how to configure the actions, see Action examples.

InviteUser action

This action invites users to a channel.

Input parameters of the InviteUser action

Parameter Name Data Type Required Description
ChannelId String True The Id of the public or private channel to invite user(s).
Users String True A comma separated list of user Ids. You can specify up to 30 users IDs.

For example on how to configure the InviteUser action, see InviteUser Example.

CloseChannel action

This action closes a direct message or multiperson direct message.

Input parameters of CloseChannel

Parameter Name Data Type Required Description
ChannelId String True Id of the conversation to close.

For example on how to configure the CloseChannel action, see CloseChannel Example.

JoinChannel action

This action allows a user to join an existing conversation.

Input parameters of JoinChannel

Parameter Name Data Type Required Description
ChannelId String True The Id of the channel to join.

For example on how to configure the JoinChannel action, see JoinChannel Example.

LeaveChannel action

This action allows a user to leave a conversation.

Input parameters of LeaveChannel

Parameter Name Data Type Required Description
ChannelId String True Id of the conversation to leave.

For example on how to configure the LeaveChannel action, see LeaveChannel Example.

OpenChannel action

This action opens or resumes a direct message or multiperson direct message.

Input parameters of OpenChannel

Parameter Name Data Type Required Description
ChannelId String True Resume a conversation by supplying the ID of the instant message or multiperson instant message, or specify the user IDs.
Users String True Comma-separated lists of users. If only one user is specified, a 1:1 direct message is created. If you don't specify any users, specify a channel ID to resume a conversation.

For example on how to configure the OpenChannel action, see OpenChannel Example.

DownloadFile action

This action downloads a file.

Input parameters of DownloadFile

Parameter Name Data Type Accepts Output Streams Description
FileId String False The Id of the file to be downloaded
FileLocation String False The location where file is to be downloaded
FileStream String True An instance of an output stream where to which to write the file data. This field is used if the FileLocation is not specified.
Encoding String False The encoding type of the FileData. You can specify BASE64 or NONE. The default value is BASE64.

For example on how to configure the DownloadFile action, see DownloadFile Example.

EndDnd action

This action ends the do not disturb mode of a user.

Input parameters of the EndDnd action

Pass an empty json, such as {}.

For example on how to configure the EndDnd action, see EndDnd Example.

SetSnooze action

This action turns on the do not disturb mode for the user or changes its duration.

Input parameters of the SetSnooze action

Parameter Name Data Type Required Description
NumOfMinutes String 60 Number of minutes to snooze the user.

For example on how to configure the SetSnooze action, see SetSnooze Example.

EndSnooze action

This action ends the user's snooze mode.

Input parameters of the EndSnooze action

Pass an empty json, such as {}.

For example on how to configure the EndSnooze action, see EndSnooze Example.

SendScheduleMessage action

This action schedules a message to be sent to a channel.

Input parameters of the SendScheduleMessage action

Pass an empty json, such as {}.

For example on how to configure the SendScheduleMessage action, see SendScheduleMessage Example.

Action examples

Example - InviteUser

  1. In the Configure connector task dialog, click Actions.
  2. Select the InviteUser action, and then click Done.
  3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "ChannelId": "C06Q6NTRNA2",
  "Users": "U070MCLRREW"
}

    4. If the action is successful, the InviteUser task's connectorOutputPayload response parameter will have a value similar to the following:

     
 [{
  "Success": "true"
}]

Example - CloseChannel

  1. In the Configure connector task dialog, click Actions.
  2. Select the CloseChannel action, and then click Done.
  3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "ChannelId": "C075U92TU4U"
}

    4. If the action is successful, the CloseChannel task's connectorOutputPayload response parameter will have a value similar to the following:

     
 [{
  "Success": "true"
}]

Example - JoinChannel

  1. In the Configure connector task dialog, click Actions.
  2. Select the JoinChannel action, and then click Done.
  3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "ChannelId": "C06UMDTL1EH"
}

    4. If the action is successful, the JoinChannel task's connectorOutputPayload response parameter will have a value similar to the following:

     
 [{
  "Success": "true"
}]

Example - LeaveChannel

  1. In the Configure connector task dialog, click Actions.
  2. Select the LeaveChannel action, and then click Done.
  3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "ChannelId": "C06UME4PM2R"
}

    4. If the action is successful, the LeaveChannel task's connectorOutputPayload response parameter will have a value similar to the following:

     
 [{
  "Success": "true"
}]

Example - OpenChannel

  1. In the Configure connector task dialog, click Actions.
  2. Select the OpenChannel action, and then click Done.
  3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"Users": "U06VCS3NDNC,U06NE4KAL0G",
"ChannelId": "C071CU9UXFF"
}

    4. If the action is successful, the OpenChannel task's connectorOutputPayload response parameter will have a value similar to the following:

     
[{
"Success": "true"
}]

Example - DownloadFile

  1. In the Configure connector task dialog, click Actions.
  2. Select the DownloadFile action, and then click Done.
  3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "FileId": "F075UHEMSN8",
  "HasBytes": true
}

    4. If the action is successful, the DownloadFile task's connectorOutputPayload response parameter will have a value similar to the following:

    [{
  "Success": "True",
  "ContentBytes": "JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPDwgL0xlbmd0aCA1IDAgUiAvRmlsdGVyIC9GbGF0ZURlY29kZSA"
}]

Additional conisderations

  • Set "HasBytes" as "True" to download other file formats, such as PDF or xlsx, which provide the contents in Base 64 encoded format.
  • To download a file in txt format, set "HasBytes" to "True" and download file content as bytes. To download the actual contents of the file, set "HasBytes" to "False".

Example - EndDnd

  1. In the Configure connector task dialog, click Actions.
  2. Select the EndDnd action, and then click Done.
  3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {}

    4. If the action is successful, the EndDnd task's connectorOutputPayload response parameter will have a value similar to the following:

     
 [{
  "Success": "true"
}]

Example - SetSnooze

  1. In the Configure connector task dialog, click Actions.
  2. Select the SetSnooze action, and then click Done.
  3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
     {
  "NumOfMinutes": "60"
}

    4. If the action is successful, the SetSnooze task's connectorOutputPayload response parameter will have a value similar to the following:

     
 [{
  "Success": "true",
  "SnoozeEnabled": "true",
  "SnoozeEndTime": "1722842455",
  "SnoozeRemaining": "3600",
  "SnoozeIsIndefinite": "false"
}]

Example - EndSnooze

  1. In the Configure connector task dialog, click Actions.
  2. Select the EndSnooze action, and then click Done.
  3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {}

    4. If the action is successful, the EndSnooze task's connectorOutputPayload response parameter will have a value similar to the following:

     
  [{
  "Success": "true",
  "DndEnabled": "true",
  "NextDndStartTime": "1722875400",
  "NextDndEndTime": "1722911400",
  "SnoozeEnabled": "false"
}]

Example - SendScheduleMessage

  1. In the Configure connector task dialog, click Actions.
  2. Select the SendScheduleMessage action, and then click Done.
  3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
     {
  "Channel": "C07AMLB39JN",
  "PostAt": "2024-08-27 14:15:00.0",
  "Text": "Hello, World!",
  "ReplyBroadCast": false
 }

    4. If the action is successful, the SendScheduleMessage task's connectorOutputPayload response parameter will have a value similar to the following:

     
   [{
  "Success": "true",
  "ok": "true",
  "scheduled_message_id": "Q07KD4YSG72",
  "channel": "C07AMLB39JN",
  "post_at": "1724768100",
  "message_user": "U071FD3TS8P",
  "message_type": "message",
  "message_bot_id": "B076304QR9V",
  "message_app_id": "A076HCDGHT5",
  "message_text": "Hello, World!",
  "message_team": "T071W04MGV8",
  "message_bot_profile_id": "B076304QR9V",
  "message_bot_profile_deleted": "false",
  "message_bot_profile_name": "Googlecloud_OAuth_Slack",
  "message_bot_profile_updated": "1717513424",
  "message_bot_profile_app_id": "A076HCDGHT5",
  "message_bot_profile_icons_image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png",
  "message_bot_profile_icons_image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png",
  "message_bot_profile_icons_image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png",
  "message_bot_profile_team_id": "T071W04MGV8",
  "message_blocks_type": "rich_text",
  "message_blocks_block_id": "MYA",
  "message_blocks_elements_type": "rich_text_section",
  "message_blocks_elements_elements_type": "text",
  "message_blocks_elements_elements_text": "Hello, World!"
}]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List records of the Messages entity

This example lists the records of the Messages entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Messages from the Entity List.
  3. Select the List operation, and then click Done.

You can perform list operation on the following entities as well: Files, MessageReplies, Pins, Reactions, Reminders,TeamInfo, UserGroups, Users, Channels, DND, Teams, UserProfile, ScheduledMessages, TeamProfileFields, and TeamProfileSections.

Example - Get records of the Calls entity

This example fetches the records of the Calls entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Calls from the Entity list.
  3. Select the Get operation, and then click Done.
  4. Set the entity ID to R070LKL3YKX which is the Key to be passed. To set the entity ID, in the Task Input section of the Connectors task, click EntityId and then enter R070LKL3YKX in the Default Value field.

The value for Entity Id must be passed directly. In this example R070LKL3YKX is the unique primary key value and it is passed directly.

You can perform get operations on the following entities as well: Calls, MessageReplies, Messages, Reactions,TeamInfo, Reminders, Users, and Channels

Example - Delete records of the Calls entity

This example deletes the records of the Calls entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Calls from the Entity list.
  3. Select the Delete operation, and then click Done.
  4. Set the entity ID to R074DSKVDSS which is the Key to be passed. To set the entity ID, in the Task Input section of the Connectors task, click EntityId and then enter R074DSKVDSS in the Default Value field.

    If the entity has two composite business or primary keys, you can set the filterClause to Id='R074DSKVDSS'.

You can perform delete operations on the following entities as well: Files, MessageReplies, Messages, Pins, Reactions, and Reminders.

Example - Create records of the Calls entity

This example creates records of the Calls entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Calls from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "ExternalUniqueId": "c249a48c-a154-43d6-a286-791df11927a4",
  "JoinURL": "https://example55.com/call"
}

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the following:

     
{
  "Id": "R074LBCFBU3"
}

Example - Create records of the Messages entity

This example creates records of the Messages entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Messages from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "ChannelId": "C06UF15CB0V",
  "Text": "This is google cloud created Message"
}

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the :

     
{
"Id": "1723008314.867479",
"ChannelId": "C06UF15CB0V"
}

Example - Create a record of the Pins entity

This example creates a record of the Pins entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Pins from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"ChannelId": "C06UF15CB0V",
"Id": "1723008314.867479",
"Type": "message"
}

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the :

     
{
"Id": "1723008314.867479",
"Type": "message",
"ChannelId": "C06UF15CB0V"
}

Example - Create a record of the Reactions entity

This example creates a record of the Reactions entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Reactions from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "ChannelId": "C06UPA4KRD0",
  "Id": "1716375032.038669",
  "Type": "message",
  "Name": "raised_hands"
}

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the following:

     
{
  "Success": true
}

Example - Create a record of the Reminders entity

This example creates a record of the Reminders entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Reminders from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "Text": "this is a reminder",
  "Time": "2025-10-15 14:30:00"
}

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the following:

     
{
  "Id": "Rm074P0X9JCV"
}

Example - Create a record of the Channels entity

This example creates a record of the Channels entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Channels from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"Name": "googlecloudcreatedchannel",
"IsPublic": true
}

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the following:

     
{
"Id": "C074MBW5N2G"
}

Example - Create a record of the MessageReplies entity

This example creates a record of the MessageReplies entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select MessageReplies from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"ChannelId": "C076HCY07UN",
"Text": "This is generated text",
"ParentMessageId": "1717659095.881619"
}

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the following:

     
{
"Id": "1717659183.033599",
"ChannelId": C076HCY07UN,
"ParentMessageId": "1717659095.881619"
}

Example - Update a record of the Calls entity

This example updates a record of the Calls entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Calls from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "JoinURL": "https://example55.com/call/google-cloud",
  "Title": "title"
}
  5. Set the entity ID to R074LB76Q5R. To set the entity ID, click entityId and then enter R074LB76Q5R in the Default Value field.

    Instead of specifying the entityId, you can also set the filterClause to R074LB76Q5R.

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
  "Id": "null"
}

Example - Update a record of the Messages entity

This example updates a record of the Messages entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Messages from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "Text": "Google Cloud Updated Message"
}
  5. Set the filterClause to ChannelId = 'C06UPA4KRD0' and Id = '1716369465.000129'. To set the filterClause, click filterClause and then enter ChannelId = 'C06UPA4KRD0' and Id = '1716369465.000129' in the Default Value field.

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
  "Id": null,
  "ChannelId": null
}

Example - Update a record of the Users entity

This example updates a record of the Users entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Users from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "ProfileDisplayName": "Vaibhav"
}
  5. Set the entity ID to U06Q6VDJYSU. To set the entity ID, click entityId and then enter U06Q6VDJYSU in the Default Value field.

    Instead of specifying the entityId, you can also set the filterClause to U06Q6VDJYSU.

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
"Id": null
}

Example - Update a record of the Channels entity

This example updates a record of the Channels entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Channels from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"Purpose": "This is the one channel that will always include everyone."
}
  5. Set the entity ID to C06MAP1JDSB. To set the entity ID, click entityId and then enter C06MAP1JDSB in the Default Value field.

    Instead of specifying the entityId, you can also set the filterClause to C06MAP1JDSB.

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
"Id": "C06MAP1JDSB"
}

Example - Update a record of the MessageReplies entity

This example updates a record of the MessageReplies entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select MessageReplies from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"Text": "Updated Text"
}
  5. Set the filterClause to ChannelId = 'C06UPA4KRD0' and Id = '1716369465.000129'. To set the filterClause, click filterClause and then enter ChannelId = 'C06UPA4KRD0' and Id = '1716369465.000129' in the Default Value field.

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
"Id": null,
"ChannelId": null,
"ParentMessageId": null
}

Example - Updates a record of the UserProfile entity

This example updates a record of the UserProfile entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select UserProfile from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
     {
  "CustomFields": "{\"Xf079082Q70B\": {\"value\": \"Patna Bihar\",\"alt\": \"\"}}",
  "Phone": "8767787654",
  "StatusText": "Long train Journey to work"
 }

    If the integration is successful, the Connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {

}

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

What's next