Webhooks API reference guide
Webhooks notify users or other systems when actions happen in Immuta. Every action that generates a notification is available as a webhook.
This page lists the REST endpoints for managing webhooks and provides examples of requests.
Application Admins can configure webhooks that are triggered by events that happen in the system (such as when data sources or projects are created), but any user can configure webhooks that are triggered by access requests and activity notifications.
All user-configured webhook integrations must respond within 10 seconds of receiving the webhook request payload. If the webhook integration takes longer to respond, the request will timeout.
POST /webhooks
Create a new webhook. Users can create multiple webhooks in a single request.
The following request with the payload below creates a new webhook.
GET /webhooks
Return a list of webhooks the user can see. (Admins can see all webhooks; users can only see their own webhooks.)
The following request returns a list of webhooks the user can see.
GET /webhooks/actions
Return a list of valid notification actions that a webhook can be triggered by. |
The following request returns a list of valid notification actions that a webhook can be triggered by.
GET /webhooks/history
Return historical records for webhook requests, including requests and responses.
The following request returns historical records for webhook requests, including requests and responses.
GET /webhooks/{id}
Return specified webhook by ID.
The following request returns details on the webhook with the ID 1.
POST /webhooks/history/retry/{id}
Retry webhook requests by history ID. This can be done against any history record, regardless of failure or success.
The following request retries the webhook with the ID 1.
DELETE /webhooks/{id}
Delete a webhook by ID.
The following request deletes the webhook with the ID 1.
The webhook request took longer than Immuta allows for a response. The default is 10 seconds, but this can be configured from the Apps Settings page.
| Type | Triggers |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Endpoint | Purpose |
|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
acknowledgedAccess
A project member acknowledges the purposes on a project.
addedToProject
A data source is added to a project.
apiKeyRevoked
A user's API key is revoked.
attributeAdded
An attribute is added to a group or user.
attributeRemoved
An attribute is removed from a group or user.
attributeUpdated
Attributes for a group or user are updated.
bulkJobStatus
A bulk action is completed (whether success/failure).
certificationRequired
A Global Policy that requires certification by the data source owner is applied to a data source.
conflictingGlobalPolicies
Global Policies are applied to the same column on a data source.
dataSourceExpired
A data source that was configured to expire has expired.
dataSourceExpiring
A data source that was configured to expire expires tomorrow.
dataSourceUpdated
A data source is updated.
deletedDatasourceRemovedFromProject
A data source has been deleted and then removed from a project.
expiredDatasourceRemovedFromProject
A data source that has expired and been deleted is removed from a project.
firstQuery
A data source is queried for the first time through Immuta.
globalPolicyCreated
A Global Policy is created.
globalPolicyDeleted
A Global Policy is deleted.
globalPolicyDisabled
A Global Policy is disabled.
globalPolicyUpdated
A Global Policy is updated.
groupUserAdded
A user is added to a group.
groupUserDeleted
A user is removed from a group.
healthCheckFailed
A health check runs and returns not healthy.
healthCheckResolved
A health check runs and returns healthy.
modelAccessApproved
A user's access request is approved for a data source or project.
modelAccessDenied
A user's access request is denied for a data source or project.
modelAccessRequested
A user requests access to a data source or project.
modelAccessRevoked
A user's access request is revoked for a data source or project.
modelAccessUpdated
A user's access level is updated for a data source or project.
modelCreated
A data source or project is created.
modelDeleted
A data source or project is deleted.
modelTagAdded
A tag is added to a data source or a data source column.
modelTagRemoved
A tag is removed from a data source or a data source column.
modelUserAdded
A user is added to a data source.
modelUserDeleted
A user is removed from a data source.
modelUserJoined
A user joins a data source that they are already allowed to join.
nativeWorkspaceStateChanged
A native workspace configuration within a project changes.
permissionsUpdated
A user's permissions are updated.
policyAdjustmentCreated
A policy adjustment is created.
policyAdjustmentExpired
A policy adjustment has expired (the default is after a year).
policyCertificationExpired
A policy certification on a data source has expired.
policyUpdated
A data source's policies have been updated by a user or Global Policy. Policy updates are triggered for many reasons, including when a data source is created, a user updates them, a Global Policy changed, tags are added to a data source or column, the data dictionary changed, a fingerprint is recomputed, an external catalog modifies tags on a linked data source, or a policy disabled.
projectDisabled
A project is disabled.
projectEqualizationMemberNotInCompliance
A member of an equalized project is out of compliance.
projectEqualizationToggled
Project equalization is toggled on or off.
projectUpdated
A project is updated.
purposeCreated
A purpose is created.
purposeDeleted
A purpose is deleted.
purposeUpdated
A purpose is updated.
queryCanceled
A running query is canceled due to a change on a data source.
queryCreated
A user creates a public query on a data source.
queryUpdated
A public query is updated.
removedFromProject
A data source is removed from a project.
switchedCurrentProject
A user switches their current project.
tagCreated
A tag is created.
tagDeleted
A tag is deleted.
tagUpdated
A tag is updated.
taskDeleted
An outstanding data source task is deleted without validation.
taskValidated
An outstanding data source task is validated.
userCloned
A user is cloned.
userCreated
A user or group is created.
userDeleted
A user or group is deleted.
userDisabled
A user is disabled.
userEnabled
A user is enabled.
userMigrated
A user is migrated from an old IAM to a new IAM.
usernameUpdated
A user's name is updated.
userUpdated
A group is updated.
webhooks
array[object] The details for each webhook you would like to create including the values for url, name, global, notificationType, actionType, and secret.
Yes
url
string URL for outbound webhook request.
Yes
name
string The webhook's name.
Yes
global
boolean If true, you will receive all notifications even if they do not pertain to you.
Yes
notificationType
array A list of the webhook notifications you would like to receive.
Yes
actionType
string The options are triggered or receive.
Yes
secret
string Shared secret for computing the webhook signature. This webhook signature must be verified by SHA1.
No
createdWebhooks
array[object] Details on each webhook that was created including values for id, url, name, global, actionType, and the date it was created.
Return a list of webhooks the user can see. (Admins can see all webhooks; users can only see their own webhooks.)
Return a list of valid notification actions that a webhook can be triggered by.
Return historical records for webhook requests, including requests and responses.
Return specified webhook by ID.
value
metadata Details regarding the returned list of webhooks including, id, name, url, notificationType, global, and createdBy.
value
metadata Details regarding the list of actions that a webhook can be created for.
offset
integer The number of records to skip for this query.
No
pageSize
integer The number of records to return in this query. The default is 20.
No
sortField
string The field to use for sorting. The default is createdAt.
No
sortOrder
string The sort order to use. The default is desc.
No
notificationType
string If set will only return activities of this type.
No
includeGlobal
boolean If true, global records will be included.
No
includeUser
boolean If true, personal webhooks will be returned for the given user. The default is true.
No
successOrFailure
string If set will only retrieve records that were successful or failed.
No
count
integer The number of results for the request.
records
metadata Details on each webhook result.
id
string The webhook ID.
Yes
value
metadata Details regarding the returned list of webhooks including, id, name, url, notificationType, global, and createdBy.
id
integer ID of the history record to retry.
Yes
id
integer The ID of the history record.
request
array Details on the request, including values for test, metadata, webhookId, and webhookName.
response
array Details on the response.
statusCode
integer The status code for the webhook. A value of 200 is successful.
notificationType
string The type of notification.
webhooksActivityId
integer The ID for the activity.
createdAt
timestamp The date the webhook was created.
updatedAt
timestamp The date the webhook was last updated.
id
integer The webhook ID.
Yes
value
metadata Details regarding the webhook, id, url, name, global, actionType, createdBy, createdAt, updatedAt.
statusCode
code
Issue
500
The request timed out.