Notifications & Webhooks

The Notifications & Webhooks tab in Administrator Settings allows you to configure email and webhook notifications for key platform events. The primary contact designated in the Company tab receives all event notifications automatically, regardless of additional email addresses configured.

Configuration

Webhook Configuration

A single webhook URL is shared across all notification types. Enter a valid URL in the Webhook URL field to enable webhook delivery. Once a valid URL is provided, a Send Webhook toggle becomes active for each event, allowing you to selectively enable webhook notifications per event type.

circle-info
  • The URL must be a valid HTTP/HTTPS endpoint

  • Webhooks are sent as POST requests with Content-Type: application/json

  • Your endpoint should return a 2xx status code to indicate successful receipt

Email Subscribers

Each event type supports a comma-separated list of email addresses. These subscribers receive email notifications in addition to the primary contact.

Event Types

Event
Key
Descripti

Integration Created

integration_created

Fired when a new integration is created on the platform

Tenant Created

tenant_created

Fired when a new tenant is created for an integration

Tenant Archived

tenant_archived

Fired when a tenant is archived

Partner Integration Updated

partner_integration_updated

Fired when a partner modifies an existing integration

Run Failed

run_failed

Fired when an integration run fails

Webhook Payload Shapes

All webhook payloads share a set of common fields, with additional fields specific to each event type.

Common Fields

Every webhook payload includes:

Field
Type
Description

event_type

string

The event key (e.g. "new_integration_created", "tenant_created")

environment

string

The namespace/environment where the event occurred

account_id

integer

The ID of the organization that owns the resource

account_name

string

The name of the organization

timestamp

string

ISO 8601 / RFC 3339 timestamp in UTC

Integration Created

Fired when a new integration is created.

Field
Type
Description

integration_id

integer

The ID of the newly created integration

integration_name

string

The display name of the integration

Tenant Created

Fired when a new tenant is created for an integration.

Field
Type
Description

tenant_id

integer

The ID of the newly created tenant

tenant_name

string

The name of the tenant

integration_id

integer

The ID of the integration the tenant belongs to

integration_name

string

The display name of the integration

Tenant Archived

Fired when a tenant is archived.

Field
Type
Description

tenant_id

integer

The ID of the archived tenant

tenant_name

string

The name of the tenant

integration_id

integer

The ID of the integration the tenant belonged to

integration_name

string

The display name of the integration

Partner Integration Updated

Fired when a partner modifies an existing integration.

Field
Type
Description

integration_id

integer

The ID of the updated integration

integration_name

string

The display name of the integration

partner_id

integer

The ID of the partner organization that made the change

partner_name

string

The name of the partner organization

Run Failed

Fired when an integration run fails. Includes direct links to the run in both the admin dashboard and the API.

Field
Type
Description

run_id

integer

The ID of the failed run

run_status

string

The status of the run (e.g. "failed")

admin_link

string

Direct link to the run in the admin dashboard

api_link

string

API endpoint for the run resource

api_status_link

string

API endpoint for the run's status

api_triggers_link

string

API endpoint for the run's triggers

tenant_id

integer

The ID of the tenant the run belongs to

tenant_name

string

The name of the tenant

integration_id

integer

The ID of the integration

integration_name

string

The display name of the integration

Delivery Details

  • Method: POST

  • Content-Type: application/json

  • Retries: Webhooks are sent once with no automatic retry on failure

  • Timeout: Standard HTTP timeout applies

  • Authentication: No authentication headers are sent with webhook requests... if you need to verify the source, validate by IP or use the webhook URL as a shared secret (e.g. include a token as a query parameter)

Last updated

Was this helpful?