Integrations and API

Goal

Manage outbound webhooks, tenant connections to connectors, and Integration & API setup (retries, read-only API policy, connector definitions).

Who it is for

integration.view / integration.manage for webhooks & connections. integration.admin for Integration & API setup. Module integration_api.

Preconditions

• Module enabled.
• Endpoint URLs reachable from BlueMatrix for webhooks.

Steps — webhooks & connections

1. Open Administration → Integrations & API.
2. Webhooks: create with Event + Endpoint URL. Copy the secret once when shown. Inspect Deliveries; delete unused hooks (integration.manage).
3. Connections: create with Connector + Name; store credentials per connector requirements.

Steps — setup

1. Open Administration → Integration & API setup.
2. Set webhook max retries, API read-only policy, and maintain connector definition catalog.

Result

Events fan out to webhook endpoints; connections authenticate connector calls. Secrets are not re-shown after create.

Hard stops

Symptom	Cause	What to do
Lost webhook secret	Shown only once	Rotate/recreate webhook
Delivery failures	Bad URL / TLS / auth	Fix endpoint; inspect Deliveries
Manage actions hidden	Missing integration.manage	Grant permission
Setup denied	Need integration.admin	Grant admin

Related

• Automation
• HR integrations
• Commerce catalog sync