Webhooks: getting notified when things happen
Quick answer
Go to Developers → Webhooks in Portal and click Add webhook. Set a name, an HTTPS URL, a payload format (Generic JSON or Slack), and optionally which event topics to send. Portal then POSTs an event to that URL whenever something matching happens, instead of you having to poll the API for changes. Only the account owner can manage webhooks.
A webhook is the opposite of the API: instead of your script asking Portal "did anything change yet?", Portal tells your endpoint the moment something does. That's useful for anything that should react quickly, paging your on-call tool, posting to a Slack channel, or kicking off a CI/CD step, without a script polling on a timer.
Setting one up
Go to Developers → Webhooks
Click Add webhook.
Fill in the form
Name (for your own reference), URL (must be HTTPS), Format (Generic JSON or Slack), and optional Topics (comma-separated; leave empty to receive every event type).
Save the signing secret immediately
Save the form. The signing secret is shown once, right after creation. Store it wherever your endpoint verifies incoming payloads, you can't view it again afterwards, only regenerate it.
Managing an existing webhook
Each webhook row carries a status badge (Healthy, Idle, Failing with a count, or Disabled) and a set of row actions: Test (send a sample event), Regenerate secret, Enable/Disable, and Delete. If a webhook starts failing, send a test event first. Most failures are a non-2xx response or a timeout on your endpoint, not a problem on the portal side.
Common integrations: Webhooks are a generic HTTP POST, so anything that can receive one works: paging tools like PagerDuty or OpsGenie, a Slack channel via the built-in Slack format, or your own automation endpoint. Which events are useful to forward depends on what you're automating. Start with everything (leave Topics empty) and narrow it down once you see what actually fires.
Webhooks
Receive real-time event notifications via HTTP POST to your own endpoints.
| Name | Status | Actions |
|---|---|---|
| order-alerts | Healthy | Test · Disable · Delete |