Skip to content

Commit 2e1c8bf

Browse files
558 - generated
1 parent 69a418b commit 2e1c8bf

File tree

2 files changed

+123
-1
lines changed
  • docs/content/docs/reference/components
  • server/libs/modules/components/slack/src/test/resources/definition

2 files changed

+123
-1
lines changed

docs/content/docs/reference/components/slack.mdx

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,10 +242,103 @@ Type: OBJECT
242242

243243

244244

245+
## Triggers
246+
247+
248+
### Any Event
249+
Name: anyEvent
250+
251+
`Triggers when any user subscribed event happens.`
252+
253+
Type: STATIC_WEBHOOK
254+
255+
256+
#### Output
257+
258+
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
259+
260+
#### JSON Example
261+
```json
262+
{
263+
"label" : "Any Event",
264+
"name" : "anyEvent",
265+
"type" : "slack/v1/anyEvent"
266+
}
267+
```
268+
269+
270+
<hr />
271+
245272

246273
## What to do if your action is not listed here?
247274

248275
If this component doesn't have the action you need, you can use **Custom Action** to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.
249276

250277
To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.
251278

279+
<hr />
280+
281+
# Additional instructions
282+
283+
## Connection Setup
284+
285+
### Create OAuth 2.0 App
286+
287+
1. Navigate to [Slack App](https://api.slack.com/apps).
288+
2. Click on **Create New App**.
289+
3. Click on **From scratch**.
290+
4. Enter name of your app and select workspace where it will be installed.
291+
5. Click on **Create App**.
292+
6. Click on **Basic Information**
293+
7. Click on **OAuth & Permissions**.
294+
8. Click on **Add New Redirect URL**. Bytechef redirect URL: https://127.0.0.1:5173/callback or https://app.bytechef.io/callback.
295+
9. Click on **Add**.
296+
10. Click on **Save URLs**.
297+
11. Click on **Add an OAuth Scope**
298+
- "channels:read"
299+
- "channels:write"
300+
- "channels:history"
301+
- "chat:write:bot"
302+
- "groups:read"
303+
- "reactions:read"
304+
- "mpim:read"
305+
- "users:read"
306+
- "incoming-webhook"
307+
12. Under OAuth tokens click on **Install to ...**.
308+
309+
<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
310+
<iframe src="https://www.guidejar.com/embed/893e27e9-f6f7-4a07-bae8-b08169858c43?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
311+
</div>
312+
313+
## Trigger Setup
314+
315+
### Enable Event Subscription
316+
317+
1. Create workflow with Slack trigger.
318+
2. Publish the workflow.
319+
3. Click on **Publish**.
320+
4. Go to **Project Deployments**.
321+
5. Click on **Create Deployment**.
322+
6. Select Slack Project.
323+
7. Select Version.
324+
8. Click on **Next**.
325+
9. Enable workflow.
326+
10. Select Connection.
327+
11. Click on **Save**.
328+
12. Enable deployment.
329+
13. Click on here to expand deployment.
330+
14. Click this icon to get webhook URL.
331+
15. Navigate to link and select your app.
332+
16. Click on **Event Subscriptions**.
333+
17. Enable Events
334+
18. Click on **Enable**.
335+
19. Click on **Change**.
336+
20. Enter copied webhook URL to verify it.
337+
21. Click on **Subscribe to bot events**.
338+
22. Click on **Add Bot User Event**.
339+
23. You can select any event you want to trigger your workflow.
340+
24. Click on **Save Changes**.
341+
342+
<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
343+
<iframe src="https://www.guidejar.com/embed/c766204a-48a4-4793-b433-7bf10e703b03?type=1&controls=on " width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
344+
</div>

server/libs/modules/components/slack/src/test/resources/definition/slack_v1.json

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4276,7 +4276,36 @@
42764276
"resources" : null,
42774277
"tags" : null,
42784278
"title" : "Slack",
4279-
"triggers" : null,
4279+
"triggers" : [ {
4280+
"batch" : null,
4281+
"deduplicate" : null,
4282+
"deprecated" : null,
4283+
"description" : "Triggers when any user subscribed event happens.",
4284+
"dynamicWebhookRefresh" : null,
4285+
"help" : null,
4286+
"listenerDisable" : null,
4287+
"listenerEnable" : null,
4288+
"name" : "anyEvent",
4289+
"outputDefinition" : {
4290+
"output" : null,
4291+
"outputResponse" : null,
4292+
"outputSchema" : null,
4293+
"sampleOutput" : null
4294+
},
4295+
"poll" : null,
4296+
"processErrorResponse" : null,
4297+
"properties" : null,
4298+
"title" : "Any Event",
4299+
"type" : "STATIC_WEBHOOK",
4300+
"webhookDisable" : null,
4301+
"webhookEnable" : null,
4302+
"webhookRawBody" : null,
4303+
"webhookRequest" : { },
4304+
"webhookValidate" : { },
4305+
"webhookValidateOnEnable" : null,
4306+
"workflowNodeDescription" : null,
4307+
"workflowSyncExecution" : null
4308+
} ],
42804309
"unifiedApi" : null,
42814310
"version" : 1
42824311
}

0 commit comments

Comments
 (0)