← Back to Pushany

🔔 Get notified with webhooks

Create a webhook URL, and whatever is sent to it arrives in your tray with a notification. It works with any service that lets you set a webhook URL, such as GitHub, monitoring services, home automation, IFTTT and Zapier.

First, in Pushany go to Settings → Integrations → Webhooks, tap “Create URL” and enter a name (for example, GitHub). Copy the URL that appears and paste it into the sending service as the webhook URL. The URL is shown only once. If you lose it, delete it and create a new one.

⚠️ Anyone who knows the URL can send to it, so keep it to yourself. What’s sent reaches our server unencrypted. The server encrypts it as soon as it arrives and stores only the encrypted version.

Sending

Send a POST request to the URL. The simplest way is to put plain text in the body.

curl -d "Backup finished" ""

Send JSON to set a title and body separately. Include a URL and it arrives as a link.

curl -H "Content-Type: application/json" \
  -d '{"title": "Server", "message": "Disk space is below 10%", "url": "https://example.com/status"}' \
  ""

How the content is read

Title	`title` or `subject`
Body	The first of `message`, `body`, `text`, `content` and `description`
URL	`url` or `link`

Slack-style (text) and Discord-style (content, embeds) messages work as they are. If a service only offers “Notify Slack”, try this URL there.
JSON without any of these fields arrives as formatted JSON, so you can see what was sent and set up a template below.
Form submissions are read from fields with the same names.
The name you gave the URL is shown as the sender on the card. If there’s no title, it’s also used as the notification title.

Choosing what to show

Add the following to the end of the URL to set the title, body and link. {{field}} is replaced with that value from the JSON you receive. Use . for nested fields and numbers (starting at 0) for arrays.

`title`	Title
`body`	Body
`url`	Link URL
`memo=1`	Save to your tray without a notification

Example: GitHub push events showing who pushed and the latest commit message

…/api/hooks/ph_…?title={{pusher.name}}&body={{head_commit.message}}&url={{compare}}

Some services require { and } to be URL-encoded (%7B and %7D).

Using it with GitHub

On GitHub, open Settings → Webhooks → Add webhook for the project you want notifications from.
For Payload URL, paste the URL with title and body added, as in the example above.
For Content type, choose application/json. You can leave Secret empty.
Choose the events you want to be notified about, then click Add webhook.

Limits

Each request can be up to 64 KB. The body is shortened to the tray’s character limit.
Each URL accepts up to 30 requests per minute.
You can create up to 10 URLs.
The number of webhooks received per day is counted across your account. See Plans for this limit and storage limits. Once you reach the limit, webhooks aren’t accepted for the rest of the day, and you’ll get a notice and a notification.

Troubleshooting

“This URL can’t be used”: the URL wasn’t copied correctly, or it was deleted.
“reached today’s webhook limit”: you’ve hit the daily limit. Webhooks are accepted again the next day (in your device’s time zone).
“Nothing to send”: the body is empty. Send some content, or add title or body to the URL.
Raw JSON arrives: none of the expected fields were found. Add a template as described in Choosing what to show.