slack connector

Description - Post a text message and optional attachments to a group or im
 
Runtime Class - com.ibi.agents.XDXSlackChatPostMessage

 

Configuration

This action requires a Generics Configuration as well as the following required parameters.
 

Parameter Groups

  Parameter Type Description
* Channel: string Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
* - denotes required
  Parameter Type Description
* Text: string Text of a message to send. Provide no more than 40,000 characters or risk truncation.
* - denotes required
  Parameter Type Description
  JSON Descriptor: string A JSON-based array of structured attachments, presented as a URL-encoded string.
* - denotes required
  Parameter Type Description
  As User: boolean true to post the message as the authed user, instead of as a bot. Defaults to false.
  Icon Emoji: string Used as the icon for the message. Overrides Icon Url. Must be used in conjunction with as_user set to false, otherwise ignored.
  Icon URL: string URL for an image to use as the icon for the message. Must be used in conjunction with as_user set to false, otherwise ignored.
  Link Names: boolean Find and link channel names and user names. Default is true.
  mrkdwn: boolean Disable Slack markup parsing by setting to false. Default is true.
  Parse Texts: string Change how Slack message texts are treated. Default is none.

Select from one of the following options:
  • none - do not parse
  • full - perform Slack formatting
  Broadcast Reply: boolean Used in conjunction with Thread Timestamp and indicates whether a reply should be made visible to everyone in the channel or conversation. Default is false.
  Unfurl Links: boolean If true, enables unfurling of primarily text-based content.
  Unfurl Media: boolean If false, disables unfurling of media content.
  User Name: string Sets your request's user name. Usually used in conjunction with As User set to false, otherwise ignored.
  Reply to message id: string To reply to another message provide the other message's Timestamp value . void using a reply's Timestamp value; use its parent instead.
* - denotes required
  Parameter Type Description
* Namespace: string Name of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
  Parameter Type Description
  On Success: string If operation was successful, the object will return the following document type.

Select from one of the following options:
  • Status Document {status} - output status
  • Results Document {results} - output response in JSON format
  • Input Document {inputDocument} - output the input document in JSON format
  On Failure: string If operation in unsuccessful, should the agent return the standard error document, or should it return its input?

Select from one of the following options:
  • Status Document {status} - The status document of execution.
  • Results Document {results} - The JSON results document of execution.
  • Input Document {inputDocument} - The original document passed into the object.
  • Error Document {errorDocument} - The error document produced by the object.
* - denotes required

 

Output Events

 

Name Description
onAccountInactive Authentication token is for a deleted user or workspace.
onActionProhibited the team associated with your request has some kind of restriction
onComplianceExportsPreventDeletion Compliance exports are on, messages can not be deleted.
onFatalError The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
onInvalidAuth Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
onIsArchived Channel has been archived.
onMissingScope Authorization prived does not have the required scope for the request. See Slack results JSON key "needed".
OnMessageTooLong Message text is too long
onNoPermission The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
onNotAuthorized No authentication token provided.
onLoginRequired The workspace is undergoing an enterprise migration and will not be available until migration is complete.
onRateLimited Application has posted too many messages, read 'https://api.slack.com/docs/rate-limits' documentation for more information
onRequestTimeout The method was called via a POST request, but the POST data was either missing or truncated.
onRestrictedAction Workspace preference prevents the authenticated user from posting.
onRollupError rolluop_error
onTeamAddedToOrg The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
onTokenRevoked Authentication token is for a deleted user or workspace or the app has been removed.
onTooManyAttachments Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.
onUserNotFound the user used in your request does not actually exist.
onFailInitialization XDXSlack agent initialization error occurred.
onFailConnect Could not connect to the external system.
onFailNhttpErrorOccurred fail_nhttp_error_occurred
onFailSlackRequestProcessing An error occurred while processing the Slack request.
onFailSlackResponseProcessing An error occurred while processing the Slack response.
onAsUserNotSupported The as_user parameter does not function with workspace apps.
onChannelIsArchived the channel has been archived and doesn't accept further messages
onChannelNotFound Channel value passed was invalid.
Description - Delete an existing message and attachments in a group or im
 
Runtime Class - com.ibi.agents.XDXSlackChatDeleteMessage

 

Configuration

This action requires a Generics Configuration as well as the following required parameters.
 

Parameter Groups

  Parameter Type Description
* ID: string Channel ID of the message.
* - denotes required
  Parameter Type Description
* Id: string Message's Timestamp Id value.
* - denotes required
  Parameter Type Description
  As User: boolean true to post the message as the authed user, instead of as a bot. Defaults to false.
* - denotes required
  Parameter Type Description
* Namespace: string Name of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
  Parameter Type Description
  On Success: string If operation was successful, the object will return the following document type.

Select from one of the following options:
  • Status Document {status} - output status
  • Results Document {results} - output response in JSON format
  • Input Document {inputDocument} - output the input document in JSON format
  On Failure: string If operation in unsuccessful, should the agent return the standard error document, or should it return its input?

Select from one of the following options:
  • Status Document {status} - The status document of execution.
  • Results Document {results} - The JSON results document of execution.
  • Input Document {inputDocument} - The original document passed into the object.
  • Error Document {errorDocument} - The error document produced by the object.
* - denotes required

 

Output Events

 

Name Description
onAccountInactive Authentication token is for a deleted user or workspace.
onActionProhibited the team associated with your request has some kind of restriction
onComplianceExportsPreventDeletion Compliance exports are on, messages can not be deleted.
onFatalError The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
onInvalidAuth Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
onIsArchived Channel has been archived.
onMissingScope Authorization prived does not have the required scope for the request. See Slack results JSON key "needed".
OnMessageTooLong Message text is too long
onNoPermission The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
onNotAuthorized No authentication token provided.
onLoginRequired The workspace is undergoing an enterprise migration and will not be available until migration is complete.
onRateLimited Application has posted too many messages, read 'https://api.slack.com/docs/rate-limits' documentation for more information
onRequestTimeout The method was called via a POST request, but the POST data was either missing or truncated.
onRestrictedAction Workspace preference prevents the authenticated user from posting.
onRollupError rolluop_error
onTeamAddedToOrg The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
onTokenRevoked Authentication token is for a deleted user or workspace or the app has been removed.
onTooManyAttachments Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.
onUserNotFound the user used in your request does not actually exist.
onFailInitialization XDXSlack agent initialization error occurred.
onFailConnect Could not connect to the external system.
onFailNhttpErrorOccurred fail_nhttp_error_occurred
onFailSlackRequestProcessing An error occurred while processing the Slack request.
onFailSlackResponseProcessing An error occurred while processing the Slack response.
onMessageNotFound No message exists with the requested timestamp.
onChannelNotFound Channel value passed was invalid.
Description - Creates a public Slack conversation.

Runtime Class - com.ibi.agents.XDXSlackConversationsCreate


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringChannel name for the conversation.
User IDs:stringA comma delimited list of between 1 and 30 human users that will be added to the newly-created conversation. /
* - denotes required
 ParameterTypeDescription
*Namespace:stringName of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
 ParameterTypeDescription
On Success:stringIf operation was successful, the object will return the following document type.

Select from one of the following options:
  • Status Document {status} - output status
  • Results Document {results} - output response in JSON format
  • Input Document {inputDocument} - output the input document in JSON format
On Failure:stringIf operation in unsuccessful, should the agent return the standard error document, or should it return its input?

Select from one of the following options:
  • Status Document {status} - The status document of execution.
  • Results Document {results} - The JSON results document of execution.
  • Input Document {inputDocument} - The original document passed into the object.
  • Error Document {errorDocument} - The error document produced by the object.
* - denotes required

Output Events

NameDescription
onAccountInactiveAuthentication token is for a deleted user or workspace.
onActionProhibitedthe team associated with your request has some kind of restriction
onComplianceExportsPreventDeletionCompliance exports are on, messages can not be deleted.
onFatalErrorThe server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
onInvalidAuthSome aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
onIsArchivedChannel has been archived.
onMissingScopeAuthorization prived does not have the required scope for the request. See Slack results JSON key "needed".
OnMessageTooLongMessage text is too long
onNoPermissionThe workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
onNotAuthorizedNo authentication token provided.
onLoginRequiredThe workspace is undergoing an enterprise migration and will not be available until migration is complete.
onRateLimitedApplication has posted too many messages, read 'https://api.slack.com/docs/rate-limits' documentation for more information
onRequestTimeoutThe method was called via a POST request, but the POST data was either missing or truncated.
onRestrictedActionWorkspace preference prevents the authenticated user from posting.
onRollupErrorrolluop_error
onTeamAddedToOrgThe workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
onTokenRevokedAuthentication token is for a deleted user or workspace or the app has been removed.
onTooManyAttachmentsToo many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.
onUserNotFoundthe user used in your request does not actually exist.
onFailInitializationXDXSlack agent initialization error occurred.
onFailConnectCould not connect to the external system.
onFailNhttpErrorOccurredfail_nhttp_error_occurred
onFailSlackRequestProcessingAn error occurred while processing the Slack request.
onFailSlackResponseProcessingAn error occurred while processing the Slack response.
onNameTakenA Conversation cannot be created with the given name.
onInvalidNameThe Value passed for name was invalid. conversation names can only contain lowercase letters, numbers, hyphens, and underscores, and must be 21 characters or less.
onInvalidNameMaxlengthThe Value passed for name exceeded max length. Conversation names can only contain lowercase letters, numbers, hyphens, and underscores, and must be 21 characters or less.
onInvalidNamePunctuationThe Value passed for name contained only punctuation. Conversation names can only contain lowercase letters, numbers, hyphens, and underscores, and must be 21 characters or less.
onInvalidNameSpecialsThe Value passed for name contained disallowed special characters or upper case characters. Conversation names can only contain lowercase letters, numbers, hyphens, and underscores, and must be 21 characters or less.
onInvalidUsersAt least one of the values passed for user_ids was empty or invalid.
onUserIsBotThis method cannot be called by a bot user.
onUserIsUltraRestrictedThis method cannot be called by a single channel guest.
Description - Creates a private conversation.
 
Runtime Class - com.ibi.agents.XDXSlackConversationsCreate

 

Configuration

This action requires a Generics Configuration as well as the following required parameters.
 

Parameter Groups

  Parameter Type Description
* Name: string Channel name for the conversation.
  User IDs: string A comma delimited list of between 1 and 30 human users that will be added to the newly-created conversation. /
* - denotes required
  Parameter Type Description
* Namespace: string Name of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
  Parameter Type Description
  On Success: string If operation was successful, the object will return the following document type.

Select from one of the following options:
  • Status Document {status} - output status
  • Results Document {results} - output response in JSON format
  • Input Document {inputDocument} - output the input document in JSON format
  On Failure: string If operation in unsuccessful, should the agent return the standard error document, or should it return its input?

Select from one of the following options:
  • Status Document {status} - The status document of execution.
  • Results Document {results} - The JSON results document of execution.
  • Input Document {inputDocument} - The original document passed into the object.
  • Error Document {errorDocument} - The error document produced by the object.
* - denotes required

 

Output Events

 

Name Description
onAccountInactive Authentication token is for a deleted user or workspace.
onActionProhibited the team associated with your request has some kind of restriction
onComplianceExportsPreventDeletion Compliance exports are on, messages can not be deleted.
onFatalError The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
onInvalidAuth Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
onIsArchived Channel has been archived.
onMissingScope Authorization prived does not have the required scope for the request. See Slack results JSON key "needed".
OnMessageTooLong Message text is too long
onNoPermission The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
onNotAuthorized No authentication token provided.
onLoginRequired The workspace is undergoing an enterprise migration and will not be available until migration is complete.
onRateLimited Application has posted too many messages, read 'https://api.slack.com/docs/rate-limits' documentation for more information
onRequestTimeout The method was called via a POST request, but the POST data was either missing or truncated.
onRestrictedAction Workspace preference prevents the authenticated user from posting.
onRollupError rolluop_error
onTeamAddedToOrg The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
onTokenRevoked Authentication token is for a deleted user or workspace or the app has been removed.
onTooManyAttachments Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.
onUserNotFound the user used in your request does not actually exist.
onFailInitialization XDXSlack agent initialization error occurred.
onFailConnect Could not connect to the external system.
onFailNhttpErrorOccurred fail_nhttp_error_occurred
onFailSlackRequestProcessing An error occurred while processing the Slack request.
onFailSlackResponseProcessing An error occurred while processing the Slack response.
onNameTaken A Conversation cannot be created with the given name.
onInvalidName The Value passed for name was invalid. conversation names can only contain lowercase letters, numbers, hyphens, and underscores, and must be 21 characters or less.
onInvalidNameMaxlength The Value passed for name exceeded max length. Conversation names can only contain lowercase letters, numbers, hyphens, and underscores, and must be 21 characters or less.
onInvalidNamePunctuation The Value passed for name contained only punctuation. Conversation names can only contain lowercase letters, numbers, hyphens, and underscores, and must be 21 characters or less.
onInvalidNameSpecials The Value passed for name contained disallowed special characters or upper case characters. Conversation names can only contain lowercase letters, numbers, hyphens, and underscores, and must be 21 characters or less.
onInvalidUsers At least one of the values passed for user_ids was empty or invalid.
onUserIsBot This method cannot be called by a bot user.
onUserIsUltraRestricted This method cannot be called by a single channel guest.
Description - closes direct (IM) messages, multi-person (MPIM) or 1:1 or otherwise.

Runtime Class - com.ibi.agents.XDXSlackConversationsClose


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*ID:stringThe ID of the channel the conversation resides in.
* - denotes required
 ParameterTypeDescription
*Namespace:stringName of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
 ParameterTypeDescription
On Success:stringIf operation was successful, the object will return the following document type.

Select from one of the following options:
  • Status Document {status} - output status
  • Results Document {results} - output response in JSON format
  • Input Document {inputDocument} - output the input document in JSON format
On Failure:stringIf operation in unsuccessful, should the agent return the standard error document, or should it return its input?

Select from one of the following options:
  • Status Document {status} - The status document of execution.
  • Results Document {results} - The JSON results document of execution.
  • Input Document {inputDocument} - The original document passed into the object.
  • Error Document {errorDocument} - The error document produced by the object.
* - denotes required

Output Events

NameDescription
onAccountInactiveAuthentication token is for a deleted user or workspace.
onActionProhibitedthe team associated with your request has some kind of restriction
onComplianceExportsPreventDeletionCompliance exports are on, messages can not be deleted.
onFatalErrorThe server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
onInvalidAuthenticationSome aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
onIsArchivedChannel has been archived.
onMissingScopeAuthorization prived does not have the required scope for the request. See Slack results JSON key "needed".
onMessageTooLongMessage text is too long
onNoPermissionThe workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
onNoAuthenticationTokenNo authentication token provided.
onFailedMigrationThe workspace is undergoing an enterprise migration and will not be available until migration is complete.
onFailRateLimitedReachedApplication has posted too many messages, read 'https://api.slack.com/docs/rate-limits' documentation for more information
onRequestTimeoutThe method was called via a POST request, but the POST data was either missing or truncated.
onRestrictedActionWorkspace preference prevents the authenticated user from posting.
onRolluopErrorrolluop_error
onTeamAddedToOrgThe workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
onTokenRevokedAuthentication token is for a deleted user or workspace or the app has been removed.
onTooManyAttachmentsToo many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.
onUserNotFoundthe user used in your request does not actually exist.
onFailAgentInitXDXSlack agent initialization error occurred.
onFailConnectCould not connect to the external system.
onFailNhttpErrorOccurredfail_nhttp_error_occurred
onFailRequestProcessingAn error occurred while processing the Slack request.
onFailResponseProcessingAn error occurred while processing the Slack response.
user_does_not_own_channeluser_does_not_own_channel
Description - Reverse archiving of a private or public conversation channel.

Runtime Class - com.ibi.agents.XDXSlackConversationsUnarchive


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*ID:stringChannel Id generated string.
* - denotes required
 ParameterTypeDescription
*Namespace:stringName of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
 ParameterTypeDescription
On Success:stringIf operation was successful, the object will return the following document type.

Select from one of the following options:
  • Status Document {status} - output status
  • Results Document {results} - output response in JSON format
  • Input Document {inputDocument} - output the input document in JSON format
Error Output Document:stringerror document or result or status or input, Default is result

Select from one of the following options:
  • status - output status
  • results - output response in JSON format
  • output input Document {inputDocument} - output the input document in JSON format
  • error Document {errorDocument} - output the XDError document
* - denotes required

Output Events

NameDescription
onAccountInactiveAuthentication token is for a deleted user or workspace.
onActionProhibitedthe team associated with your request has some kind of restriction
onComplianceExportsPreventDeletionCompliance exports are on, messages can not be deleted.
onFatalErrorThe server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
onInvalidAuthenticationSome aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
onIsArchivedChannel has been archived.
onMissingScopeAuthorization prived does not have the required scope for the request. See Slack results JSON key "needed".
onMessageTooLongMessage text is too long
onNoPermissionThe workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
onNoAuthenticationTokenNo authentication token provided.
onFailedMigrationThe workspace is undergoing an enterprise migration and will not be available until migration is complete.
onFailRateLimitedReachedApplication has posted too many messages, read 'https://api.slack.com/docs/rate-limits' documentation for more information
onRequestTimeoutThe method was called via a POST request, but the POST data was either missing or truncated.
onRestrictedActionWorkspace preference prevents the authenticated user from posting.
onRolluopErrorrolluop_error
onTeamAddedToOrgThe workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
onTokenRevokedAuthentication token is for a deleted user or workspace or the app has been removed.
onTooManyAttachmentsToo many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.
onUserNotFoundthe user used in your request does not actually exist.
onFailAgentInitXDXSlack agent initialization error occurred.
onFailConnectCould not connect to the external system.
onFailNhttpErrorOccurredfail_nhttp_error_occurred
onFailRequestProcessingAn error occurred while processing the Slack request.
onFailResponseProcessingAn error occurred while processing the Slack response.
Description - Set the topic of a Slack Conversation.

Runtime Class - com.ibi.agents.XDXSlackConversationsSetTopic


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*User Token:passwordSlack User authorization token. This limits the response to the User's scopes.
* - denotes required
 ParameterTypeDescription
*ID:stringChannel/Conversation ID generated string.
*Topic:stringThe topic for the conversation.
* - denotes required
 ParameterTypeDescription
*Namespace:stringName of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
 ParameterTypeDescription
On Success:stringIf operation was successful, the object will return the following document type.

Select from one of the following options:
  • Status Document {status} - output status
  • Results Document {results} - output response in JSON format
  • Input Document {inputDocument} - output the input document in JSON format
Error Output Document:stringerror document or result or status or input, Default is result

Select from one of the following options:
  • status - output status
  • results - output response in JSON format
  • output input Document {inputDocument} - output the input document in JSON format
  • error Document {errorDocument} - output the XDError document
* - denotes required

Output Events

NameDescription
onAccountInactiveAuthentication token is for a deleted user or workspace.
onActionProhibitedthe team associated with your request has some kind of restriction
onComplianceExportsPreventDeletionCompliance exports are on, messages can not be deleted.
onFatalErrorThe server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
onInvalidAuthenticationSome aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
onIsArchivedChannel has been archived.
onMissingScopeAuthorization prived does not have the required scope for the request. See Slack results JSON key "needed".
onMessageTooLongMessage text is too long
onNoPermissionThe workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
onNoAuthenticationTokenNo authentication token provided.
onFailedMigrationThe workspace is undergoing an enterprise migration and will not be available until migration is complete.
onFailRateLimitedReachedApplication has posted too many messages, read 'https://api.slack.com/docs/rate-limits' documentation for more information
onRequestTimeoutThe method was called via a POST request, but the POST data was either missing or truncated.
onRestrictedActionWorkspace preference prevents the authenticated user from posting.
onRolluopErrorrolluop_error
onTeamAddedToOrgThe workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
onTokenRevokedAuthentication token is for a deleted user or workspace or the app has been removed.
onTooManyAttachmentsToo many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.
onUserNotFoundthe user used in your request does not actually exist.
onFailAgentInitXDXSlack agent initialization error occurred.
onFailConnectCould not connect to the external system.
onFailNhttpErrorOccurredfail_nhttp_error_occurred
onFailRequestProcessingAn error occurred while processing the Slack request.
onFailResponseProcessingAn error occurred while processing the Slack response.
channel_not_foundChannel value passed was invalid.
not_in_channelCannot post user messages to a channel they are not in.
too_longtoo_long
user_is_restricteduser_is_restricted
method_not_supported_for_channel_typeThis type of conversation cannot be used with this method.
Description - Sets a description for the purpose of a Slack Conversation.
 
Runtime Class - com.ibi.agents.XDXSlackConversationsSetPurpose

 

Configuration

This action requires a Generics Configuration as well as the following required parameters.
 

Parameter Groups

  Parameter Type Description
* ID: string Channel Id generated string.
* Purpose: string The purpose associated with the conversation.
* - denotes required
  Parameter Type Description
* Namespace: string Name of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
  Parameter Type Description
  On Success: string If operation was successful, the object will return the following document type.

Select from one of the following options:
  • Status Document {status} - output status
  • Results Document {results} - output response in JSON format
  • Input Document {inputDocument} - output the input document in JSON format
  Error Output Document: string error document or result or status or input, Default is result

Select from one of the following options:
  • status - output status
  • results - output response in JSON format
  • output input Document {inputDocument} - output the input document in JSON format
  • error Document {errorDocument} - output the XDError document
* - denotes required

 

Output Events

 

Name Description
onAccountInactive Authentication token is for a deleted user or workspace.
onActionProhibited the team associated with your request has some kind of restriction
onComplianceExportsPreventDeletion Compliance exports are on, messages can not be deleted.
onFatalError The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
onInvalidAuthentication Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
onIsArchived Channel has been archived.
onMissingScope Authorization prived does not have the required scope for the request. See Slack results JSON key "needed".
onMessageTooLong Message text is too long
onNoPermission The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
onNoAuthenticationToken No authentication token provided.
onFailedMigration The workspace is undergoing an enterprise migration and will not be available until migration is complete.
onFailRateLimitedReached Application has posted too many messages, read 'https://api.slack.com/docs/rate-limits' documentation for more information
onRequestTimeout The method was called via a POST request, but the POST data was either missing or truncated.
onRestrictedAction Workspace preference prevents the authenticated user from posting.
onRolluopError rolluop_error
onTeamAddedToOrg The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
onTokenRevoked Authentication token is for a deleted user or workspace or the app has been removed.
onTooManyAttachments Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.
onUserNotFound the user used in your request does not actually exist.
onFailAgentInit XDXSlack agent initialization error occurred.
onFailConnect Could not connect to the external system.
onFailNhttpErrorOccurred fail_nhttp_error_occurred
onFailRequestProcessing An error occurred while processing the Slack request.
onFailResponseProcessing An error occurred while processing the Slack response.
channel_not_found Channel value passed was invalid.
not_in_channel Cannot post user messages to a channel they are not in.
too_long too_long
user_is_restricted user_is_restricted
method_not_supported_for_channel_type This type of conversation cannot be used with this method.
Description - Start a Direct (IM) or Multipoint (MPIM) conversation.
 
Runtime Class - com.ibi.agents.XDXSlackConversationsOpenNew

 

Configuration

This action requires a Generics Configuration as well as the following required parameters.
 

Parameter Groups

  Parameter Type Description
  User IDs: string A comma delimited list of between 1 and 30 human users that will be associated with the a conversation. When target is a direct message (IM) conversation, more than one user id in this list implies a multipoint (MPIM) direct conversation
* - denotes required
  Parameter Type Description
* Verbose: boolean The response will include all the detailed direct message (IM) information.
* - denotes required
  Parameter Type Description
* Namespace: string Name of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
  Parameter Type Description
  On Success: string If operation was successful, the object will return the following document type.

Select from one of the following options:
  • Status Document {status} - output status
  • Results Document {results} - output response in JSON format
  • Input Document {inputDocument} - output the input document in JSON format
  On Failure: string If operation in unsuccessful, should the agent return the standard error document, or should it return its input?

Select from one of the following options:
  • Status Document {status} - The status document of execution.
  • Results Document {results} - The JSON results document of execution.
  • Input Document {inputDocument} - The original document passed into the object.
  • Error Document {errorDocument} - The error document produced by the object.
* - denotes required

 

Output Events

 

Name Description
onAccountInactive Authentication token is for a deleted user or workspace.
onActionProhibited the team associated with your request has some kind of restriction
onComplianceExportsPreventDeletion Compliance exports are on, messages can not be deleted.
onFatalError The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
onInvalidAuthentication Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
onIsArchived Channel has been archived.
onMissingScope Authorization prived does not have the required scope for the request. See Slack results JSON key "needed".
onMessageTooLong Message text is too long
onNoPermission The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
onNoAuthenticationToken No authentication token provided.
onFailedMigration The workspace is undergoing an enterprise migration and will not be available until migration is complete.
onFailRateLimitedReached Application has posted too many messages, read 'https://api.slack.com/docs/rate-limits' documentation for more information
onRequestTimeout The method was called via a POST request, but the POST data was either missing or truncated.
onRestrictedAction Workspace preference prevents the authenticated user from posting.
onRolluopError rolluop_error
onTeamAddedToOrg The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
onTokenRevoked Authentication token is for a deleted user or workspace or the app has been removed.
onTooManyAttachments Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.
onUserNotFound the user used in your request does not actually exist.
onFailAgentInit XDXSlack agent initialization error occurred.
onFailConnect Could not connect to the external system.
onFailNhttpErrorOccurred fail_nhttp_error_occurred
onFailRequestProcessing An error occurred while processing the Slack request.
onFailResponseProcessing An error occurred while processing the Slack response.
invalid_users At least one of the values passed for user_ids was empty or invalid.
not_enough_users not_enough_users
too_many_users too_many_users
user_disabled user_disabled
user_list_not_supplied user_list_not_supplied
user_not_visible user_not_visible
Description - closes direct (IM) messages, multi-person (MPIM) or 1:1 or otherwise.
 
Runtime Class - com.ibi.agents.XDXSlackConversationsClose

 

Configuration

This action requires a Generics Configuration as well as the following required parameters.
 

Parameter Groups

  Parameter Type Description
* ID: string The ID of the channel the conversation resides in.
* - denotes required
  Parameter Type Description
* Namespace: string Name of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
  Parameter Type Description
  On Success: string If operation was successful, the object will return the following document type.

Select from one of the following options:
  • Status Document {status} - output status
  • Results Document {results} - output response in JSON format
  • Input Document {inputDocument} - output the input document in JSON format
  On Failure: string If operation in unsuccessful, should the agent return the standard error document, or should it return its input?

Select from one of the following options:
  • Status Document {status} - The status document of execution.
  • Results Document {results} - The JSON results document of execution.
  • Input Document {inputDocument} - The original document passed into the object.
  • Error Document {errorDocument} - The error document produced by the object.
* - denotes required

 

Output Events

 

Name Description
onAccountInactive Authentication token is for a deleted user or workspace.
onActionProhibited the team associated with your request has some kind of restriction
onComplianceExportsPreventDeletion Compliance exports are on, messages can not be deleted.
onFatalError The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
onInvalidAuthentication Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
onIsArchived Channel has been archived.
onMissingScope Authorization prived does not have the required scope for the request. See Slack results JSON key "needed".
onMessageTooLong Message text is too long
onNoPermission The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
onNoAuthenticationToken No authentication token provided.
onFailedMigration The workspace is undergoing an enterprise migration and will not be available until migration is complete.
onFailRateLimitedReached Application has posted too many messages, read 'https://api.slack.com/docs/rate-limits' documentation for more information
onRequestTimeout The method was called via a POST request, but the POST data was either missing or truncated.
onRestrictedAction Workspace preference prevents the authenticated user from posting.
onRolluopError rolluop_error
onTeamAddedToOrg The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
onTokenRevoked Authentication token is for a deleted user or workspace or the app has been removed.
onTooManyAttachments Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.
onUserNotFound the user used in your request does not actually exist.
onFailAgentInit XDXSlack agent initialization error occurred.
onFailConnect Could not connect to the external system.
onFailNhttpErrorOccurred fail_nhttp_error_occurred
onFailRequestProcessing An error occurred while processing the Slack request.
onFailResponseProcessing An error occurred while processing the Slack response.
user_does_not_own_channel user_does_not_own_channel