slack connector

Description - Archive a private or public conversation channel.

Runtime Class - com.ibi.agents.XDXSlackConversationsArchive


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.
Description - Create a Slack file.using an existing file
 
Runtime Class - com.ibi.agents.XDXSlackFilesUploadData

 

Configuration

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

Parameter Groups

  Parameter Type Description
* File Path: string File Path of the file to upload.
* - denotes required
  Parameter Type Description
  File Name: string Filename for the file uploaded
  File Type: string Slack supported file type. If blank the type of data in the file will be intuited from the filename and the magic bytes in the file, for supported formats.

Select from one of the following options:
  • auto - Auto Detect Type
  • text - Plain Text
  • ai - Illustrator File
  • apk - APK
  • applescript - AppleScript
  • binary - Binary
  • bmp - Bitmap
  • boxnote - BoxNote
  • label {c} - C
  • csharp - C#
  • cpp - C++
  • css - CSS
  • csv - CSV
  • clojure - Clojure
  • coffeescript - CoffeeScript
  • cfm - ColdFusion
  • d - D
  • dart - Dart
  • diff - Diff
  • doc - Word Document
  • docx - Word document
  • dockerfile - Docker
  • dotx - Word template
  • email - Email
  • eps - EPS
  • epub - EPUB
  • erlang - Erlang
  • fla - Flash FLA
  • flv - Flash video
  • fsharp - F#
  • fortran - Fortran
  • gdoc - GDocs Document
  • gdraw - GDocs Drawing
  • gif - GIF
  • go - Go
  • gpres - GDocs Presentation
  • groovy - Groovy
  • gsheet - GDocs Spreadsheet
  • gzip - GZip
  • html - HTML
  • handlebars - Handlebars
  • haskell - Haskell
  • haxe - Haxe
  • indd - InDesign Document
  • java - Java
  • javascript - JavaScript/JSON
  • jpg - JPEG
  • keynote - Keynote Document
  • kotlin - Kotlin
  • latex - LaTeX/sTeX
  • lisp - Lisp
  • lua - Lua
  • m4a - MPEG 4 audio
  • markdown - Markdown (raw)
  • matlab - MATLAB
  • mhtml - MHTML
  • mkv - Matroska video
  • mov - QuickTime video
  • mp3 - mp4
  • mp4 - MPEG 4 video
  • mpg - MPEG video
  • mumps - MUMPS
  • numbers - Numbers Document
  • nzb - NZB
  • objc - Objective-C
  • ocaml - OCaml
  • odg - OpenDocument Drawing
  • odi - OpenDocument Image
  • odp - OpenDocument Presentation
  • odd - OpenDocument Spreadsheet
  • odt - OpenDocument Text
  • ogg - Ogg Vorbis
  • ogv - Ogg video
  • pages - Pages Document
  • pascal - Pascal
  • pdf - PDF
  • perl - Perl
  • php - PHP
  • pig - Pig
  • png - PNG
  • post - Slack Post
  • powershell - PowerShell
  • ppt - PowerPoint presentation
  • pptx - PowerPoint presentation
  • psd - Photoshop Document
  • puppet - Puppet
  • pythonlabel {python} - Python
  • qtz - Quartz Composer Composition
  • r - R
  • rtf - Rich Text File
  • ruby - Ruby
  • rust - Rust
  • sql - SQL
  • sass - Sass
  • scala - Scala
  • scheme - Scheme
  • sketch - Sketch File
  • shell - Shell
  • smalltalk - Smalltalk
  • svg - SVG
  • swf - Flash SWF
  • swift - Swift
  • tar - Tarball
  • tiff - TIFF
  • tsv - TSV
  • vb - VB.NET
  • vbscript - VBScript
  • vcard - vCard
  • velocity - Velocity
  • verilog - Verilog
  • wav - Waveform audio
  • webm - WebM
  • wmv - Windows Media Video
  • xls - Excel spreadsheet
  • xlsx - Excel spreadsheet
  • xlsb - Excel Spreadsheet (Binary, Macro Enabled)
  • xlsm - Excel Spreadsheet (Macro Enabled)
  • xltx - Excel template
  • xml - XML
  • yaml - YAML
  • zip - Zip
  Title: string Title Of the file.
  Comment: string Initial comment to add to file.
  Reply to message id: string The message id of a message to reply to.
* - denotes required
  Parameter Type Description
  Channels: string Comma-separated list of channel names or IDs where the file will be shared.
* - 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.
onFileDeleted File id passed is deleted.
onFileNotFound File id passed was not found.
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 - Create a Slack file.using the input

Runtime Class - com.ibi.agents.XDXSlackFilesUploadInput


Configuration

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

Parameter Groups

 ParameterTypeDescription
File Name:stringFilename for the file uploaded
File Type:stringSlack supported file type. If blank the type of data in the file will be intuited from the filename and the magic bytes in the file, for supported formats.

Select from one of the following options:
  • auto - Auto Detect Type
  • text - Plain Text
  • ai - Illustrator File
  • apk - APK
  • applescript - AppleScript
  • binary - Binary
  • bmp - Bitmap
  • boxnote - BoxNote
  • label {c} - C
  • csharp - C#
  • cpp - C++
  • css - CSS
  • csv - CSV
  • clojure - Clojure
  • coffeescript - CoffeeScript
  • cfm - ColdFusion
  • d - D
  • dart - Dart
  • diff - Diff
  • doc - Word Document
  • docx - Word document
  • dockerfile - Docker
  • dotx - Word template
  • email - Email
  • eps - EPS
  • epub - EPUB
  • erlang - Erlang
  • fla - Flash FLA
  • flv - Flash video
  • fsharp - F#
  • fortran - Fortran
  • gdoc - GDocs Document
  • gdraw - GDocs Drawing
  • gif - GIF
  • go - Go
  • gpres - GDocs Presentation
  • groovy - Groovy
  • gsheet - GDocs Spreadsheet
  • gzip - GZip
  • html - HTML
  • handlebars - Handlebars
  • haskell - Haskell
  • haxe - Haxe
  • indd - InDesign Document
  • java - Java
  • javascript - JavaScript/JSON
  • jpg - JPEG
  • keynote - Keynote Document
  • kotlin - Kotlin
  • latex - LaTeX/sTeX
  • lisp - Lisp
  • lua - Lua
  • m4a - MPEG 4 audio
  • markdown - Markdown (raw)
  • matlab - MATLAB
  • mhtml - MHTML
  • mkv - Matroska video
  • mov - QuickTime video
  • mp3 - mp4
  • mp4 - MPEG 4 video
  • mpg - MPEG video
  • mumps - MUMPS
  • numbers - Numbers Document
  • nzb - NZB
  • objc - Objective-C
  • ocaml - OCaml
  • odg - OpenDocument Drawing
  • odi - OpenDocument Image
  • odp - OpenDocument Presentation
  • odd - OpenDocument Spreadsheet
  • odt - OpenDocument Text
  • ogg - Ogg Vorbis
  • ogv - Ogg video
  • pages - Pages Document
  • pascal - Pascal
  • pdf - PDF
  • perl - Perl
  • php - PHP
  • pig - Pig
  • png - PNG
  • post - Slack Post
  • powershell - PowerShell
  • ppt - PowerPoint presentation
  • pptx - PowerPoint presentation
  • psd - Photoshop Document
  • puppet - Puppet
  • pythonlabel {python} - Python
  • qtz - Quartz Composer Composition
  • r - R
  • rtf - Rich Text File
  • ruby - Ruby
  • rust - Rust
  • sql - SQL
  • sass - Sass
  • scala - Scala
  • scheme - Scheme
  • sketch - Sketch File
  • shell - Shell
  • smalltalk - Smalltalk
  • svg - SVG
  • swf - Flash SWF
  • swift - Swift
  • tar - Tarball
  • tiff - TIFF
  • tsv - TSV
  • vb - VB.NET
  • vbscript - VBScript
  • vcard - vCard
  • velocity - Velocity
  • verilog - Verilog
  • wav - Waveform audio
  • webm - WebM
  • wmv - Windows Media Video
  • xls - Excel spreadsheet
  • xlsx - Excel spreadsheet
  • xlsb - Excel Spreadsheet (Binary, Macro Enabled)
  • xlsm - Excel Spreadsheet (Macro Enabled)
  • xltx - Excel template
  • xml - XML
  • yaml - YAML
  • zip - Zip
Title:stringTitle Of the file.
Comment:stringInitial comment to add to file.
Reply to message id:stringThe message id of a message to reply to.
* - denotes required
 ParameterTypeDescription
Channels:stringComma-separated list of channel names or IDs where the file will be shared.
* - 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.
onFileDeletedFile id passed is deleted.
onFileNotFoundFile id passed was not found.
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 - Update an existing message and optional attachments for a group or im

Runtime Class - com.ibi.agents.XDXSlackChatUpdateMessage


Configuration

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

Parameter Groups

 ParameterTypeDescription
*Channel ID:stringChannel Id of the message.
* - denotes required
 ParameterTypeDescription
*Text:stringText of a message to send. Provide no more than 40,000 characters or risk truncation.
*Message ID:stringmessage's Timestamp value.
* - denotes required
 ParameterTypeDescription
JSON Descriptor:stringA JSON-based array of structured attachments, presented as a URL-encoded string.
* - denotes required
 ParameterTypeDescription
As User:booleantrue to post the message as the authed user, instead of as a bot. Defaults to false.
Link Names:booleanFind and link channel names and user names. Default is true.
Parse Texts:stringChange how Slack message texts are treated. Default is none.

Select from one of the following options:
  • none - do not parse
  • full - perform Slack formatting
* - 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.
onMessageNotFoundNo message exists with the requested timestamp.
onChannelIsArchivedthe channel has been archived and doesn't accept further messages
onChannelNotFoundChannel value passed was invalid.
Description - Update an existing comment for an uploaded Slack file
 
Runtime Class - com.ibi.agents.XDXSlackFilesCommentsEdit

 

Configuration

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

Parameter Groups

  Parameter Type Description
* Text: string Comment for the file.
* - denotes required
  Parameter Type Description
* Comment Id: string Comment Id of the comment to be updated.
* File Id: string File Id of the target file.
* - 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.
onFileDeleted File id passed is deleted.
onFileNotFound File id passed was not found.
onCommentNotFound Comment ID passed was invalid.
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 - Update an existing attachments and optional text for a group or im

Runtime Class - com.ibi.agents.XDXSlackChatUpdateAttachment


Configuration

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

Parameter Groups

 ParameterTypeDescription
*Channel ID:stringChannel Id of the message.
* - denotes required
 ParameterTypeDescription
*Message ID:stringmessage's Timestamp value.
*JSON Descriptor:stringA JSON-based array of structured attachments, presented as a URL-encoded string.
* - denotes required
 ParameterTypeDescription
Text:stringText of a message to send. Provide no more than 40,000 characters or risk truncation.
* - denotes required
 ParameterTypeDescription
As User:booleantrue to post the message as the authed user, instead of as a bot. Defaults to false.
Link Names:booleanFind and link channel names and user names. Default is true.
Parse Texts:stringChange how Slack message texts are treated. Default is none.

Select from one of the following options:
  • none - do not parse
  • full - perform Slack formatting
* - 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.
onAttachmentNotFoundThe attachment was not found with the specified message
onChannelIsArchivedthe channel has been archived and doesn't accept further messages
onChannelNotFoundChannel value passed was invalid.
Description - Delete the Authentication Token sent from the workspace, can also test the process

Runtime Class - com.ibi.agents.XDXSlackAuthRevoke


Configuration

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

Parameter Groups

 ParameterTypeDescription
Revoke:booleanIf true the process performs all checks and processes except actually revoking the token.
* - 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
onComplianceExportsPrevent_DeletionCompliance 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.
onOrgLoginRequiredThe 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.
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
onFailSlackRequestProcessingAn error occurred while processing the Slack request.
onFailSlackResponseProcessingAn error occurred while processing the Slack response.
successrequested operation completed
as_user_not_supportedThe as_user parameter does not function with workspace apps.
onChannelIsArchivedthe channel has been archived and doesn't accept further messages
onChannelNotFoundChannel value passed was invalid.
Description - Post attachments and optional text message to a group or im
 
Runtime Class - com.ibi.agents.XDXSlackChatPostAttachment

 

Configuration

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

Parameter Groups

  Parameter Type Description
* Channel Name: string Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
* - 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
  Text: string Text of a message to send. Provide no more than 40,000 characters or risk truncation.
* - 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.
  Markup Parsing: 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 - List the Users in your group, team, or workspace

Runtime Class - com.ibi.agents.XDXSlackUsersList


Configuration

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

Parameter Groups

 ParameterTypeDescription
Maximum Items:stringThe maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. The dfault is 100.
Information Start:stringStart for a multipage display of retrieved information. Use Slack response Json key nextCursor value to continue a response. Default value fetches the first page; see https://api.slack.com/docs/pagination
Include Presence Data:booleanWhether to include presence data in the output. Defaults to false. Setting this to true reduces performance.
Include Locale:booleanif true the locale of the channel is included. The default is false.
* - 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.
unknown_errorthe API returned an undocumented error response. See resonse JSON key error.
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 - List the User information

Runtime Class - com.ibi.agents.XDXSlackUsersInfo


Configuration

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

Parameter Groups

 ParameterTypeDescription
Maximum Items:stringThe maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. The dfault is 100.
Information Start:stringStart for a multipage display of retrieved information. Use Slack response Json key nextCursor value to continue a response. Default value fetches the first page; see https://api.slack.com/docs/pagination
Include Locale:booleanif true the locale of the channel is included. The default is false.
* - 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.
onFileDeletedFile id passed is deleted.
onFileNotFoundFile id passed was not found.
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.