Skip to content
Docs · Incoming webhooks

Chat

Incoming webhooks

Post into a Yomenie channel from CI, monitoring or scripts. Slack-compatible: paste the Yomenie URL where a tool asks for a Slack webhook.

Updated

On this page

An incoming webhook lets a tool post into a Yomenie channel: deploys from CI, errors from Sentry, releases from GitHub, anything that can send an HTTP request. It speaks Slack’s format, so a tool that posts to a Slack incoming webhook works here when you paste the Yomenie URL instead.

Messages show in the channel under the webhook’s name with a small App tag, live, like any other message.

Add one

Owners and admins can add webhooks.

  1. Open the channel in Chat, click its name in the header to open Channel details, and go to the Apps tab.
  2. Choose Add incoming webhook, give it a name (“GitHub”, “CI”, “Sentry”) and, if you like, an icon: an emoji, a shortcode like :rocket:, or an https:// image URL.
  3. Confirm it’s you if asked (a passkey, or an email link).
  4. Copy the URL. It looks like https://yomenie.us/hooks/ym_wh_… and is shown only once.

Treat the URL like a password: anyone who has it can post in that channel. Keep it in your CI’s secrets, not in a repository. If it leaks, regenerate it (below).

Everyone who can read the channel sees which webhooks post into it, who added them, when they were last used and how many messages they sent. Webhooks belong to the workspace: they keep working when the person who added them leaves.

Post a message

curl -X POST -H 'Content-type: application/json' \
  --data '{"text":"Deploy of <https://github.com/northwind/app/actions/runs/42|run #42> *succeeded*"}' \
  https://yomenie.us/hooks/ym_wh_...

A successful post answers 200 with the body ok.

Slack’s form encoding works too:

curl -X POST --data-urlencode 'payload={"text":"Nightly build passed"}' https://yomenie.us/hooks/ym_wh_...

What you can send

Field
text The message, in Slack’s mrkdwn (below). Required unless blocks or attachments carry text.
username Shows instead of the webhook’s name for this message (one line, up to 40 characters).
icon_emoji An emoji or a shortcode like :tada: for this message.
icon_url Accepted and ignored: only the icon set on the webhook shows, so a sender can’t make every reader’s browser load an image from their server.
blocks, attachments When there’s no text, their text is shown as plain lines: section text and fields, headers and context; an attachment’s fallback, or its pretext, title and text. Buttons, images and layout aren’t shown yet.

Other fields are ignored, so payloads written for Slack don’t fail.

Formatting

Slack’s mrkdwn is turned into Yomenie’s markdown:

You send You see
*bold*, _italic_, ~strike~ bold, italic, strike
<https://example.com|label>, <https://example.com> a link (http, https and mailto only)
`code` and ```blocks``` code, left exactly as sent
&amp;, &lt;, &gt; &, <, >
<!here>, <!channel>, <@U123> plain text: nobody is pinged

Raw HTML is never rendered. Text longer than a chat message (8,000 characters) is cut with “…”.

Errors

Errors are short plain-text codes, like Slack’s:

Status Body Meaning
400 invalid_payload The body isn’t JSON (or a form with payload=) in Slack’s shape.
400 no_text Nothing to show: no text, and no text in blocks or attachments.
404 no_service The URL is wrong, was regenerated, or the webhook was revoked.
404 channel_not_found The channel is gone.
410 channel_archived The channel is archived. The webhook works again once it’s unarchived (unless it was revoked).
413 payload_too_large The body is over 64 KB.
429 rate_limited Too fast: about one message a second, bursts of 20. Wait for Retry-After seconds.
405 method_not_allowed Only POST works.

GitHub Actions

Store the URL as a repository secret named YOMENIE_WEBHOOK_URL, then post with curl:

- name: Tell #deploys
  if: always()
  env:
    YOMENIE_WEBHOOK_URL: ${{ secrets.YOMENIE_WEBHOOK_URL }}
  run: |
    curl -sf -X POST -H 'Content-type: application/json' \
      --data "{\"text\":\"${{ github.workflow }} on <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|${{ github.ref_name }}>: *${{ job.status }}*\"}" \
      "$YOMENIE_WEBHOOK_URL"

Or keep using Slack’s action, pointed at the Yomenie URL:

- uses: slackapi/slack-github-action@v2
  with:
    webhook: ${{ secrets.YOMENIE_WEBHOOK_URL }}
    webhook-type: incoming-webhook
    payload: |
      text: "Release ${{ github.ref_name }} is out"

Sentry, Vercel, Zapier, n8n and other tools with a “Slack incoming webhook” option work the same way: paste the Yomenie URL where they ask for the Slack one.

Regenerate or revoke

In Channel details → Apps, owners and admins can:

  • Regenerate URL: a new URL, shown once. The old one stops working at once. Use it when a URL may have leaked.
  • Revoke: the webhook stops working for good and leaves the list. Messages it already posted stay.

Archiving a channel pauses its webhooks: they answer 410 channel_archived until the channel is unarchived, and the Apps tab says so.

Adding, regenerating and revoking are in the workspace’s audit log. The messages themselves are ordinary chat.

Self-hosting and local development

With pnpm dev there’s no edge Worker, so the API takes webhooks itself at http://localhost:8787/hooks/<token> (only in AUTH_MODE=dev). In production the Worker answers /hooks/<token>.