Manage Webhooks

Required Immuta permission: APPLICATION_ADMIN

Webhook configuration

With the UI

1. Navigate to the Webhooks page.

2. Click New webhook.

3. Enter the Webhook URL to send the webhook to.

4. Opt to enter a Secret.

5. If necessary, disable TLS verification with the toggle. Disabling is not recommended.

6. Click Save.

With the API

Ensure you set the correct global segment and use a Request app personal access token (PAT) when using the Request app API. See the Request app API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

Create webhook

post

Create a new webhook

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

urlstring · uriRequired

verifyTlsbooleanOptionalDefault: true

signingKeystringOptional

Responses

200Success

application/json

idstring · uuidRequired

urlstring · uriRequired

verifyTlsbooleanOptionalDefault: true

signingKeybooleanOptionalDefault: false

suppressedbooleanOptionalDefault: false

post

/api/notification/webhook

HTTPcURLJavaScriptPython

POST /marketplace/api/notification/webhook HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": "text"
}

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": false,
  "suppressed": false
}

Test the webhook

With the UI

To send a test webhook to all your configured webhooks,

1. Navigate to the Webhooks page.

2. Click Test webhook in the actions column of any webhook. It will send out a test payload to all the configured webhooks.

With the API

Ensure you set the correct global segment and use a Request app personal access token (PAT) when using the Request app API. See the Request app API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

Test webhook configuration

post

Test all webhook configurations

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

urlstring · uriRequired

verifyTlsbooleanOptionalDefault: true

signingKeystringOptional

Responses

200Success

application/json

statusstring · enumRequiredPossible values:

httpStatusCodenumberRequired

errorMessagestringOptional

post

/api/notification/webhook/test

HTTPcURLJavaScriptPython

POST /marketplace/api/notification/webhook/test HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": "text"
}

200Success

{
  "status": "UNSPECIFIED",
  "httpStatusCode": 1,
  "errorMessage": "text"
}

Reset a webhook secret

If you lose or forget the secret you set in a webhook, you can reset it.

Update integrations

Any integrations using the old secret must be updated once you reset it.

With the UI

1. Navigate to the Webhooks page.

2. Click the webhook you want to edit, which will open the side-sheet.

3. Click Reset secret.

With the API

Ensure you set the correct global segment and use a Request app personal access token (PAT) when using the Request app API. See the Request app API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

Update webhook

put

Update the details of a specific webhook by ID

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

urlstring · uriOptional

verifyTlsbooleanOptionalDefault: true

signingKeystringOptional

Responses

200Success

application/json

idstring · uuidRequired

urlstring · uriRequired

verifyTlsbooleanOptionalDefault: true

signingKeybooleanOptionalDefault: false

suppressedbooleanOptionalDefault: false

put

/api/notification/webhook/{id}

HTTPcURLJavaScriptPython

PUT /marketplace/api/notification/webhook/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": "text"
}

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": false,
  "suppressed": false
}

Delete webhook

With the UI

1. Navigate to the Webhooks page.

2. Click the webhook you want to delete, which will open the side-sheet.

3. Click Delete, and then Delete again.

With the API

Ensure you set the correct global segment and use a Request app personal access token (PAT) when using the Request app API. See the Request app API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

Delete webhook

delete

Delete a specific webhook by ID

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

204Success

delete

/api/notification/webhook/{id}

HTTPcURLJavaScriptPython

DELETE /marketplace/api/notification/webhook/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204Success

No content