RabbinatixDocs
Sign inGet started

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 app

What the Integrations page holds

Open Integrations in the sidebar. It has four tabs:

TabWhat it is for
API & CIThe HTTP API, with copyable checks for your pipeline
API tokensTokens for CI and your scripts
WebhooksEvents sent to your own endpoint or an email address
AI assistantsYour own AI for chat (Claude, ChatGPT or Gemini), and keys for the AI assistant in your editor

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

  1. Open Webhooks and click New webhook.
  2. Give it a Name, for example API alerts.
  3. Pick a Type: HTTP or Email.
  4. For HTTP, paste your endpoint's URL. For email, type the Email address.
  5. Tick the Events it should receive.
  6. Click Create webhook.
  7. 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.

EventCodeWhen
Contract status changescontract.status_changedA contract changes status
API added, API changedendpoint.created, endpoint.updatedAn endpoint is added or changed
API lifecycle changesendpoint.lifecycle_changedAn endpoint moves to to do, in progress or deployed
API deprecated, API shutdown is nearendpoint.deprecated, endpoint.sunset_soonAn endpoint is deprecated, or its shutdown is near
New public API versionsapi.version_publishedAn API version is published
Blocked deploymentsdeployment.blockedA deployment would break a consumer
Errors and warnings reported by serviceshealth.signalA service reports an error or a warning
Ticket created, Ticket moved, Ticket resolved, Ticket commentsticket.created, ticket.moved, ticket.resolved, ticket.commentedTicket changes

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.

NoteIn a local emulator, deliveries are recorded but not sent. The result says so.

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.

Email

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.

  1. Open API tokens and click New token.
  2. Give it a Name, for example GitHub Actions. Two tokens can't share a name.
  3. Pick its Scopes: read, publish or deploy. Give it only what it needs.
  4. 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.