Work as a team
Integrations
Send contract and ticket events to your own endpoint or an email address with webhooks, and see each delivery and its retries.
Open Integrations in the appWhat the Integrations page holds
Open Integrations in the sidebar. It has four tabs:
CI is covered in CI and the API, and assistants in your AI assistant. This guide covers webhooks.
Webhooks and API tokens need the Integrations permission. Owners and Admins have it. Without it, those two tabs say so and show neither the list nor its buttons.
Create a webhook
- Open Webhooks and click New webhook.
- Give it a Name, for example
API alerts. - Pick a Type: HTTP or Email.
- For HTTP, paste your endpoint's URL. For email, type the Email address.
- Tick the Events it should receive.
- Click Create webhook.
- For HTTP, copy the signing secret now. It is shown only once. An email webhook has none.
Events
Events are listed by name. Hover one to see the code that arrives in the delivery's type.
Check the signature
Every delivery is signed. Your endpoint should check the X-Rabbinatix-Signature header with the signing secret before it trusts the body. If the secret leaks, delete the webhook and create a new one.
Test, pause and delete
- Send test sends a test event now and shows the result on the webhook's card.
- The switch on each card pauses or resumes deliveries.
- The bin icon deletes the webhook. It stops receiving events at once.
Deliveries and retries
Recent deliveries lists each delivery with its webhook, event, result, attempt and time. Tick Failed only to see only the problems.
When a delivery fails, Rabbinatix tries again after 5 minutes, 15 minutes, 30 minutes, 2 hours and 12 hours. That makes six attempts in all. The result shows when the next try is due, or that it gave up. Click Retry now to send a failed delivery again straight away.
One webhook per receiver
Give each webhook only the events its receiver needs. A team that owns Auth Service might get contract.status_changed and deployment.blocked, and nothing else. For conversation inside Rabbinatix, use chat.
An email webhook sends events to one address, such as a team mailing list. Each person's own email notifications are set on the notifications page.
API tokens
Tokens let your pipelines and scripts call Rabbinatix.
- Open API tokens and click New token.
- Give it a Name, for example
GitHub Actions. Two tokens can't share a name. - Pick its Scopes: read, publish or deploy. Give it only what it needs.
- Click Create token and copy it. It won't be shown again.
Revoke stops a token at once, and pipelines using it fail. AI assistants use keys of their own, not API tokens. See the API and tokens.
Related
- NotificationsHear about the events that matter to you: in the app or by email, with a level for each kind of event.
- API and tokensCreate API tokens for CI and scripts, choose their scopes, and call the REST API at /api/v1.
- CI and the APIGate deployments in CI with the safety check and record what you deploy, using an API token and the HTTP API.
- Connect your AI assistantConnect the AI assistant in your editor with a key of your own, let it read and draft, and review its drafts before anything changes.
