Skip to content

docs: document Slack integration custom message format#2504

Open
marcel-rbro wants to merge 2 commits intomasterfrom
docs/slack-message-template
Open

docs: document Slack integration custom message format#2504
marcel-rbro wants to merge 2 commits intomasterfrom
docs/slack-message-template

Conversation

@marcel-rbro
Copy link
Copy Markdown
Contributor

@marcel-rbro marcel-rbro commented May 6, 2026

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-appended Sent by Apify line, TEST event behavior, and empty-template fallback.
  • ## Template variables with sub-sections:
    • ### Event dataactorId, actorTaskId, actorRunId, actorBuildId
    • ### Resource (Actor run) — full table of frequently used resource.* 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 object admonition 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.
  • Cross-link from Step 1 to the new Custom message format section so the existing setup flow points readers at the new reference.

Page cleanup (existing content)

  • Intro tightened — removed the lead paragraph that duplicated the frontmatter description verbatim, collapsed two separate tutorial pointers (one was a blockquote with an orphan --- rule above it) into one, and replaced the wordy value paragraph with a single value-forward sentence.
  • Image alt text — replaced generic alt text on all three screenshots (Integrations tab, Integration setup, Use Apify from Slack) with descriptive text.
  • Step 1 prose — switched to active voice ("Log in ... when prompted"), dropped wordy phrasings ("events you would like to be notified of", "Once you are done"), and restructured the long event-selection sentence.
  • Misc style — removed redundant "the" before [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.ts and webhooks.ts schema). Status values match what's exposed by the integration handler.

Test plan

  • pnpm lint:md passes
  • vale --minAlertLevel=error passes
  • Front matter description within 140-160 chars (147)
  • On the deploy preview, verify the #status-values anchor link works and the Apify Console URL patterns in the example templates resolve

Closes #2490

🤖 Generated with Claude Code

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>
@github-actions github-actions Bot added the t-docs Issues owned by technical writing team. label May 6, 2026
@marcel-rbro marcel-rbro requested review from MQ37 and TC-MO May 6, 2026 15:47
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-docs Issues owned by technical writing team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Slack integration custom message format and template variables

2 participants