docs: document Slack integration custom message format#2504
Open
marcel-rbro wants to merge 2 commits into
Open
docs: document Slack integration custom message format#2504marcel-rbro wants to merge 2 commits into
marcel-rbro wants to merge 2 commits into
Conversation
Adds reference for the Handlebars template engine used by the Slack integration, the full list of template variables (eventData and resource fields, run and build), status enum values, and four ready-to-paste message examples. Also tightens the page intro: the lead paragraph duplicated the frontmatter description verbatim, the same tutorial link appeared twice (once in a blockquote with an orphan horizontal rule), and the value paragraph was wordy. Replaces with a single value-forward intro plus the tutorial pointer, and fixes a few existing style nits caught while reviewing (image alt text, "feel free", redundant "the" before an Actor name). Closes #2490 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Pre-existing style nits caught during PR review: - Active voice: "Log in ... when prompted" instead of "you will be prompted" - Drop wordy "events you would like to be notified of" and the "Once you are done" conditional opener - Restructure the long event-selection sentence into shorter clauses Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
MQ37
approved these changes
May 7, 2026
TC-MO
approved these changes
May 20, 2026
Contributor
TC-MO
left a comment
TC-MO
left a comment
There was a problem hiding this comment.
Few things to change but most not connected to PR itself - good opportunity for cleanup
| [Slack](https://slack.com/) allows you to install various services in your workspace in order to automate and centralize jobs. Apify is one of these services, and it allows you to run your Apify Actors, get notified about their run statuses, and receive your results, all without opening your browser. | ||
| For a step-by-step walkthrough, see the [Apify integration for Slack tutorial](https://help.apify.com/en/articles/6454058-apify-integration-for-slack). | ||
|
|
||
| <ThirdPartyDisclaimer /> |
Contributor
There was a problem hiding this comment.
Is this truly a third party? Similar case as with GitHub integration
|  | ||
|  | ||
|
|
||
| When an Actor doesn't require you to fill in any input fields, you can run it by simply typing `/apify call [Actor or task ID]`. |
Contributor
There was a problem hiding this comment.
let's use this opportunity to nuke simply
| @@ -1,3 +1,3 @@ | |||
| --- | |||
| title: Slack integration | |||
| description: Learn how to integrate your Apify Actors with Slack. This article guides you from installation through to automating your whole workflow in Slack. | |||
Contributor
There was a problem hiding this comment.
Suggested change
| description: Learn how to integrate your Apify Actors with Slack, from installation through setting up notifications and running Actors directly from Slack. |
|
|
||
| ## Get started | ||
|
|
||
| To use the Apify integration for Slack, you will need: |
Contributor
There was a problem hiding this comment.
Suggested change
| To use the Apify integration for Slack, you need: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #2490 by documenting the Slack integration's custom message template format and the full list of template variables. Also tightens existing prose on the page.
New reference content
## Custom message format— Handlebars template engine, Slack mrkdwn syntax, 2–4000 char length limit, auto-appendedSent by Apifyline, TEST event behavior, and empty-template fallback.## Template variableswith sub-sections:### Event data—actorId,actorTaskId,actorRunId,actorBuildId### Resource (Actor run)— full table of frequently usedresource.*fields (id, status, statusMessage, startedAt, finishedAt, defaultDatasetId, options., stats., meta.origin, etc.)### Resource (Actor build)— build-specific resource fields### Status values— split list for runs vs builds:::tip Full resource objectadmonition pointing to the Get run / Get build API responses## Message template examples— four ready-to-paste templates: minimal status notification, run summary with Apify Console links, failure alert with{{#if}}conditionals, and build notification.Custom message formatsection so the existing setup flow points readers at the new reference.Page cleanup (existing content)
---rule above it) into one, and replaced the wordy value paragraph with a single value-forward sentence.Integrations tab,Integration setup,Use Apify from Slack) with descriptive text.[Google Shopping Scraper], replaced "feel free to reach out to us on our [Discord channel]" with "reach out on the [Apify Discord channel]".Variable accuracy
Variables and their structure are grounded in the integration's source code (
slack_webhook_handler.tsandwebhooks.tsschema). Status values match what's exposed by the integration handler.Test plan
pnpm lint:mdpassesvale --minAlertLevel=errorpasses#status-valuesanchor link works and the Apify Console URL patterns in the example templates resolveCloses #2490
🤖 Generated with Claude Code