Book a demo

Manage Webhooks

Private preview: Webhooks for Marketplace are in private preview and are available to select accounts. Contact your Immuta representative for details.

Required Immuta permission: GOVERNANCE

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 Marketplace-specific personal access token (PAT) when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

post
Authorizations
Body
Responses
200Success
application/json
post
/api/notification/webhook
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: 80

{
  "recipient": {
    "url": "https://example.com",
    "verifyTls": true,
    "signingKey": "text"
  }
}
200Success
{
  "recipient": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "url": "https://example.com",
    "verifyTls": true,
    "suppressed": false,
    "signingKeySet": 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 Marketplace-specific personal access token (PAT) when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

post
Authorizations
Body
urlstring · uriRequired
verifyTlsbooleanOptionalDefault: true
signingKeystringOptional
Responses
200Success
application/json
post
/api/notification/webhook/test
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 Marketplace-specific personal access token (PAT) when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

put
Authorizations
Path parameters
idstringRequired
Body
urlstring · uriOptional
verifyTlsbooleanOptionalDefault: true
signingKeystringOptional
suppressedbooleanOptionalDefault: false
Responses
200Success
application/json
put
/api/notification/webhook/{id}
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: 85

{
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": "text",
  "suppressed": false
}
200Success
{
  "recipient": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "url": "https://example.com",
    "verifyTls": true,
    "suppressed": false,
    "signingKeySet": 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 Marketplace-specific personal access token (PAT) when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

delete
Authorizations
Path parameters
idstringRequired
Responses
204Success
No content
delete
/api/notification/webhook/{id}
DELETE /marketplace/api/notification/webhook/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204Success
No content
PreviousManage Email NotificationsNextReference Guides

Last updated

Was this helpful?