Setup
- Go to Settings → Connections → Webhooks
- Click Add Webhook and give it a name (e.g.
ci-pipeline) - Copy your API key. It’s shown once and can’t be retrieved later.
URL Allowlisting
If you want Macroscope to deliver results to an external URL (rather than Slack), that URL must be allowlisted first. For example, if you’re routing results to a Zapier or n8n webhook endpoint, add that URL here. Manage the list in Settings → Connections → Webhooks → Allowed External URLs. Only GitHub organization admins can add or remove URLs. Must be HTTPS.Request
Every request needs two headers:The question to ask the agent.
Where to deliver the results. Use
slackChannelId (string) to post to Slack, or webhookUrl (string) to POST to an external URL (must be allowlisted). Optionally include slackThreadTs (string) to reply in a specific Slack thread.IANA timezone (e.g.
America/Los_Angeles). Affects date references in the query.202 Accepted with a workflowId:
Example Requests
Deliver results to Slack:Response Payload
When the agent finishes, Macroscope POSTs this to your Slack channel or URL:Error Codes
| Code | Meaning |
|---|---|
202 | Query accepted. |
400 | Malformed request or missing query. |
401 | Missing or invalid X-Webhook-Secret. |
403 | Wrong workspace, or webhook URL not allowlisted. |
Use Cases
- Post-deploy summaries: GitHub Actions runs a deploy, triggers a webhook asking “what changed in this release?”, and Macroscope posts a plain-English summary to your team’s Slack channel.
- Incident response: wire a PagerDuty or Sentry alert to trigger a Macroscope webhook. The agent can investigate the error, open a PR with a proposed fix, assign the most relevant teammate as a reviewer, and post a summary to your on-call Slack channel.
- No-code automations: a Zapier or n8n workflow triggers Macroscope every Monday morning to generate a weekly engineering digest and routes the answer to email, Notion, or wherever your team tracks updates.