{"action":"created","comment":{"url":"https://api.github.com/repos/workato/docs/pulls/comments/191108556","pull_request_review_id":123618539,"id":191108556,"diff_hunk":"@@ -0,0 +1,200 @@\n+---\n+title: Custom actions\n+date: 2018-05-24 14:00:00 Z\n+---\n+\n+# Custom actions\n+If you're looking to build additional actions for a connector that Workato already supports, custom actions enable you to utilize the existing connector framework instead of developing from scratch via the [HTTP universal connector](/developing-connectors/http.md) or the [SDK](/developing-connectors/sdk.md). This allows you to easily build your action by telling Workato what the action's request and response should look like, which can be obtained from the API documentation.\n+\n+Building a custom action is an accelerated way of building an action via the HTTP connector, as the custom action utilizes the connector's existing authorization framework and already understands the API for that app.\n+\n+## App support for custom actions\n+Most apps on Workato support custom actions. Custom actions can be found in the actions picklist of the connector.\n+\n+![Selecting the custom action](/assets/images/developing-connectors/custom-actions/custom-action-selection.png)\n+*Selecting the custom action*\n+\n+The custom action will list the scopes available. Typically, you can only read or write to objects that you have scopes for. We see that we have the following scopes for Slack:\n+\n+```\n+channels:read, channels:write, chat:write:bot, chat:write:user, groups:read, groups:write,\n+identify, users:read\n+```\n+\n+![App scopes available for the custom action](/assets/images/developing-connectors/custom-actions/app-scopes.png)\n+*App scopes available for the custom action*\n+\n+If you build an action that requires additional scopes, the action will throw an error when it tries to make the request with the API. For example, this error is returned when we try to build a create reminder action in Slack, as we have no `reminders:write` permission.\n+\n+![Scope error returned by the API when call is made](/assets/images/developing-connectors/custom-actions/custom-action-scope-error-output.png)\n+*Scope error returned by the API when call is made*\n+\n+If you'd like to see custom actions or additional scopes added to a connector on Workato, contact the Workato team to file an enhancement request!\n+\n+## Custom action input fields\n+This section details the configuration input fields in the custom action.\n+\n+| Input field                     | Description                                                                                                                                                       |\n+|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n+| Action name                     | Give the custom action you're building a name. This shows up in the action title.                                                                                 |\n+| Request type                    | HTTP method of the API endpoint you're calling.                                                                                                                   |\n+| Path                            | URL path of the endpoint you're calling. Absolute URI or relative URI are accepted.  Use the absolute URI if you wish to use a different version of the API, etc. |\n+| URL params (For GET and DELETE) | If the API endpoint you're calling is a GET or a DELETE, you can pass in URL params.                                                                              |","path":"developing-connectors/custom-actions.md","position":42,"original_position":42,"commit_id":"66b2cdec873c8d54f5be3542fc8db7b9502ddd86","original_commit_id":"66b2cdec873c8d54f5be3542fc8db7b9502ddd86","user":{"login":"eeshansim","id":10286963,"avatar_url":"https://avatars3.githubusercontent.com/u/10286963?v=4","gravatar_id":"","url":"https://api.github.com/users/eeshansim","html_url":"https://github.com/eeshansim","followers_url":"https://api.github.com/users/eeshansim/followers","following_url":"https://api.github.com/users/eeshansim/following{/other_user}","gists_url":"https://api.github.com/users/eeshansim/gists{/gist_id}","starred_url":"https://api.github.com/users/eeshansim/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eeshansim/subscriptions","organizations_url":"https://api.github.com/users/eeshansim/orgs","repos_url":"https://api.github.com/users/eeshansim/repos","events_url":"https://api.github.com/users/eeshansim/events{/privacy}","received_events_url":"https://api.github.com/users/eeshansim/received_events","type":"User","site_admin":false},"body":"Can we remove \"(For GET and DELETE)\" from the Input field and mention in description that This input field will appear only if user selects GET or DELETE Request type. Also, we should mention that all values will be URL encoded automatically.\r\n\r\nExample:\r\n\r\nIf the Request type is a GET or DELETE, this input will appear. This input is used to construct URL parameters that will be included in the API request. Values provided here will be URL encoded before being sent. ","created_at":"2018-05-28T04:22:36Z","updated_at":"2018-05-28T04:48:55Z","html_url":"https://github.com/workato/docs/pull/495#discussion_r191108556","pull_request_url":"https://api.github.com/repos/workato/docs/pulls/495","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/workato/docs/pulls/comments/191108556"},"html":{"href":"https://github.com/workato/docs/pull/495#discussion_r191108556"},"pull_request":{"href":"https://api.github.com/repos/workato/docs/pulls/495"}}},"pull_request":{"url":"https://api.github.com/repos/workato/docs/pulls/495","id":190609989,"html_url":"https://github.com/workato/docs/pull/495","diff_url":"https://github.com/workato/docs/pull/495.diff","patch_url":"https://github.com/workato/docs/pull/495.patch","issue_url":"https://api.github.com/repos/workato/docs/issues/495","number":495,"state":"open","locked":false,"title":"Custom actions docs","user":{"login":"huilinn","id":6780917,"avatar_url":"https://avatars3.githubusercontent.com/u/6780917?v=4","gravatar_id":"","url":"https://api.github.com/users/huilinn","html_url":"https://github.com/huilinn","followers_url":"https://api.github.com/users/huilinn/followers","following_url":"https://api.github.com/users/huilinn/following{/other_user}","gists_url":"https://api.github.com/users/huilinn/gists{/gist_id}","starred_url":"https://api.github.com/users/huilinn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/huilinn/subscriptions","organizations_url":"https://api.github.com/users/huilinn/orgs","repos_url":"https://api.github.com/users/huilinn/repos","events_url":"https://api.github.com/users/huilinn/events{/privacy}","received_events_url":"https://api.github.com/users/huilinn/received_events","type":"User","site_admin":false},"body":"","created_at":"2018-05-25T14:42:02Z","updated_at":"2018-05-28T04:48:55Z","closed_at":null,"merged_at":null,"merge_commit_sha":"e6d6c0affe0e0b888c4b0bc11f160b50f5aa94fc","assignee":{"login":"eeshansim","id":10286963,"avatar_url":"https://avatars3.githubusercontent.com/u/10286963?v=4","gravatar_id":"","url":"https://api.github.com/users/eeshansim","html_url":"https://github.com/eeshansim","followers_url":"https://api.github.com/users/eeshansim/followers","following_url":"https://api.github.com/users/eeshansim/following{/other_user}","gists_url":"https://api.github.com/users/eeshansim/gists{/gist_id}","starred_url":"https://api.github.com/users/eeshansim/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eeshansim/subscriptions","organizations_url":"https://api.github.com/users/eeshansim/orgs","repos_url":"https://api.github.com/users/eeshansim/repos","events_url":"https://api.github.com/users/eeshansim/events{/privacy}","received_events_url":"https://api.github.com/users/eeshansim/received_events","type":"User","site_admin":false},"assignees":[{"login":"eeshansim","id":10286963,"avatar_url":"https://avatars3.githubusercontent.com/u/10286963?v=4","gravatar_id":"","url":"https://api.github.com/users/eeshansim","html_url":"https://github.com/eeshansim","followers_url":"https://api.github.com/users/eeshansim/followers","following_url":"https://api.github.com/users/eeshansim/following{/other_user}","gists_url":"https://api.github.com/users/eeshansim/gists{/gist_id}","starred_url":"https://api.github.com/users/eeshansim/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eeshansim/subscriptions","organizations_url":"https://api.github.com/users/eeshansim/orgs","repos_url":"https://api.github.com/users/eeshansim/repos","events_url":"https://api.github.com/users/eeshansim/events{/privacy}","received_events_url":"https://api.github.com/users/eeshansim/received_events","type":"User","site_admin":false}],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/workato/docs/pulls/495/commits","review_comments_url":"https://api.github.com/repos/workato/docs/pulls/495/comments","review_comment_url":"https://api.github.com/repos/workato/docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/workato/docs/issues/495/comments","statuses_url":"https://api.github.com/repos/workato/docs/statuses/66b2cdec873c8d54f5be3542fc8db7b9502ddd86","head":{"label":"workato:custom-actions","ref":"custom-actions","sha":"66b2cdec873c8d54f5be3542fc8db7b9502ddd86","user":{"login":"workato","id":5629924,"avatar_url":"https://avatars3.githubusercontent.com/u/5629924?v=4","gravatar_id":"","url":"https://api.github.com/users/workato","html_url":"https://github.com/workato","followers_url":"https://api.github.com/users/workato/followers","following_url":"https://api.github.com/users/workato/following{/other_user}","gists_url":"https://api.github.com/users/workato/gists{/gist_id}","starred_url":"https://api.github.com/users/workato/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/workato/subscriptions","organizations_url":"https://api.github.com/users/workato/orgs","repos_url":"https://api.github.com/users/workato/repos","events_url":"https://api.github.com/users/workato/events{/privacy}","received_events_url":"https://api.github.com/users/workato/received_events","type":"Organization","site_admin":false},"repo":{"id":82145434,"name":"docs","full_name":"workato/docs","owner":{"login":"workato","id":5629924,"avatar_url":"https://avatars3.githubusercontent.com/u/5629924?v=4","gravatar_id":"","url":"https://api.github.com/users/workato","html_url":"https://github.com/workato","followers_url":"https://api.github.com/users/workato/followers","following_url":"https://api.github.com/users/workato/following{/other_user}","gists_url":"https://api.github.com/users/workato/gists{/gist_id}","starred_url":"https://api.github.com/users/workato/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/workato/subscriptions","organizations_url":"https://api.github.com/users/workato/orgs","repos_url":"https://api.github.com/users/workato/repos","events_url":"https://api.github.com/users/workato/events{/privacy}","received_events_url":"https://api.github.com/users/workato/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/workato/docs","description":null,"fork":false,"url":"https://api.github.com/repos/workato/docs","forks_url":"https://api.github.com/repos/workato/docs/forks","keys_url":"https://api.github.com/repos/workato/docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/workato/docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/workato/docs/teams","hooks_url":"https://api.github.com/repos/workato/docs/hooks","issue_events_url":"https://api.github.com/repos/workato/docs/issues/events{/number}","events_url":"https://api.github.com/repos/workato/docs/events","assignees_url":"https://api.github.com/repos/workato/docs/assignees{/user}","branches_url":"https://api.github.com/repos/workato/docs/branches{/branch}","tags_url":"https://api.github.com/repos/workato/docs/tags","blobs_url":"https://api.github.com/repos/workato/docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/workato/docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/workato/docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/workato/docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/workato/docs/statuses/{sha}","languages_url":"https://api.github.com/repos/workato/docs/languages","stargazers_url":"https://api.github.com/repos/workato/docs/stargazers","contributors_url":"https://api.github.com/repos/workato/docs/contributors","subscribers_url":"https://api.github.com/repos/workato/docs/subscribers","subscription_url":"https://api.github.com/repos/workato/docs/subscription","commits_url":"https://api.github.com/repos/workato/docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/workato/docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/workato/docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/workato/docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/workato/docs/contents/{+path}","compare_url":"https://api.github.com/repos/workato/docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/workato/docs/merges","archive_url":"https://api.github.com/repos/workato/docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/workato/docs/downloads","issues_url":"https://api.github.com/repos/workato/docs/issues{/number}","pulls_url":"https://api.github.com/repos/workato/docs/pulls{/number}","milestones_url":"https://api.github.com/repos/workato/docs/milestones{/number}","notifications_url":"https://api.github.com/repos/workato/docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/workato/docs/labels{/name}","releases_url":"https://api.github.com/repos/workato/docs/releases{/id}","deployments_url":"https://api.github.com/repos/workato/docs/deployments","created_at":"2017-02-16T06:04:38Z","updated_at":"2018-05-25T08:22:35Z","pushed_at":"2018-05-25T14:57:15Z","git_url":"git://github.com/workato/docs.git","ssh_url":"git@github.com:workato/docs.git","clone_url":"https://github.com/workato/docs.git","svn_url":"https://github.com/workato/docs","homepage":null,"size":336426,"stargazers_count":2,"watchers_count":2,"language":"HTML","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":9,"mirror_url":null,"archived":false,"open_issues_count":133,"license":null,"forks":9,"open_issues":133,"watchers":2,"default_branch":"master"}},"base":{"label":"workato:master","ref":"master","sha":"1b348f9b18e1091b04f06287dbb2a8cfc8e06f5b","user":{"login":"workato","id":5629924,"avatar_url":"https://avatars3.githubusercontent.com/u/5629924?v=4","gravatar_id":"","url":"https://api.github.com/users/workato","html_url":"https://github.com/workato","followers_url":"https://api.github.com/users/workato/followers","following_url":"https://api.github.com/users/workato/following{/other_user}","gists_url":"https://api.github.com/users/workato/gists{/gist_id}","starred_url":"https://api.github.com/users/workato/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/workato/subscriptions","organizations_url":"https://api.github.com/users/workato/orgs","repos_url":"https://api.github.com/users/workato/repos","events_url":"https://api.github.com/users/workato/events{/privacy}","received_events_url":"https://api.github.com/users/workato/received_events","type":"Organization","site_admin":false},"repo":{"id":82145434,"name":"docs","full_name":"workato/docs","owner":{"login":"workato","id":5629924,"avatar_url":"https://avatars3.githubusercontent.com/u/5629924?v=4","gravatar_id":"","url":"https://api.github.com/users/workato","html_url":"https://github.com/workato","followers_url":"https://api.github.com/users/workato/followers","following_url":"https://api.github.com/users/workato/following{/other_user}","gists_url":"https://api.github.com/users/workato/gists{/gist_id}","starred_url":"https://api.github.com/users/workato/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/workato/subscriptions","organizations_url":"https://api.github.com/users/workato/orgs","repos_url":"https://api.github.com/users/workato/repos","events_url":"https://api.github.com/users/workato/events{/privacy}","received_events_url":"https://api.github.com/users/workato/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/workato/docs","description":null,"fork":false,"url":"https://api.github.com/repos/workato/docs","forks_url":"https://api.github.com/repos/workato/docs/forks","keys_url":"https://api.github.com/repos/workato/docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/workato/docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/workato/docs/teams","hooks_url":"https://api.github.com/repos/workato/docs/hooks","issue_events_url":"https://api.github.com/repos/workato/docs/issues/events{/number}","events_url":"https://api.github.com/repos/workato/docs/events","assignees_url":"https://api.github.com/repos/workato/docs/assignees{/user}","branches_url":"https://api.github.com/repos/workato/docs/branches{/branch}","tags_url":"https://api.github.com/repos/workato/docs/tags","blobs_url":"https://api.github.com/repos/workato/docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/workato/docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/workato/docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/workato/docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/workato/docs/statuses/{sha}","languages_url":"https://api.github.com/repos/workato/docs/languages","stargazers_url":"https://api.github.com/repos/workato/docs/stargazers","contributors_url":"https://api.github.com/repos/workato/docs/contributors","subscribers_url":"https://api.github.com/repos/workato/docs/subscribers","subscription_url":"https://api.github.com/repos/workato/docs/subscription","commits_url":"https://api.github.com/repos/workato/docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/workato/docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/workato/docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/workato/docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/workato/docs/contents/{+path}","compare_url":"https://api.github.com/repos/workato/docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/workato/docs/merges","archive_url":"https://api.github.com/repos/workato/docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/workato/docs/downloads","issues_url":"https://api.github.com/repos/workato/docs/issues{/number}","pulls_url":"https://api.github.com/repos/workato/docs/pulls{/number}","milestones_url":"https://api.github.com/repos/workato/docs/milestones{/number}","notifications_url":"https://api.github.com/repos/workato/docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/workato/docs/labels{/name}","releases_url":"https://api.github.com/repos/workato/docs/releases{/id}","deployments_url":"https://api.github.com/repos/workato/docs/deployments","created_at":"2017-02-16T06:04:38Z","updated_at":"2018-05-25T08:22:35Z","pushed_at":"2018-05-25T14:57:15Z","git_url":"git://github.com/workato/docs.git","ssh_url":"git@github.com:workato/docs.git","clone_url":"https://github.com/workato/docs.git","svn_url":"https://github.com/workato/docs","homepage":null,"size":336426,"stargazers_count":2,"watchers_count":2,"language":"HTML","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":9,"mirror_url":null,"archived":false,"open_issues_count":133,"license":null,"forks":9,"open_issues":133,"watchers":2,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/workato/docs/pulls/495"},"html":{"href":"https://github.com/workato/docs/pull/495"},"issue":{"href":"https://api.github.com/repos/workato/docs/issues/495"},"comments":{"href":"https://api.github.com/repos/workato/docs/issues/495/comments"},"review_comments":{"href":"https://api.github.com/repos/workato/docs/pulls/495/comments"},"review_comment":{"href":"https://api.github.com/repos/workato/docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/workato/docs/pulls/495/commits"},"statuses":{"href":"https://api.github.com/repos/workato/docs/statuses/66b2cdec873c8d54f5be3542fc8db7b9502ddd86"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"eeshansim"}}