Post webhook verification

Overview

This endpoint registers a new webhook to receive the real-time activity feed. Provide your webhookUrl, a publicKey for verification, and any necessary customHeaders. A successful call creates the webhook configuration and returns its unique ID. Use this API as the initial setup step for any application that needs to receive live event notifications from the Trellix EDR platform. This is the required process to configure a destination for real-time data streams, such as new threat alerts or endpoint status changes. This API enables a push-based data integration, allowing your systems to react instantly to security events rather than discovering them through periodic polling.

Authentication

Authentication type: Bearer Token, API Key.

You can create a token using client credentials obtained through the developer portal. The API Key (x-api-key) is provided in your onboarding email or on the API Access Management page.

Path (or URL)

<HTTPS Method>
POST https://{Trellix EDR_gateway_URL}/edr/v2/activity-feed/webhook-verification

Request

Request headers

Authorization: Bearer <your_bearer_token>
Content-Type: application/vnd.api+json
x-api-key: <your_api_key>

Authorization: This header is used to authenticate your request. You need to replace <your_bearer_token> with the actual token you generate.
Content-Type: This header tells the server that the request body format is json:api. Even though this specific call has no request body, the API requires this header.
x-api-key: This is a custom header required by the Trellix API for authentication. You'll need to replace <your_api_key> with the key from your onboarding email or the API Access Management page.

Request parameters

No request parameters

Request example

{
  "data": {
    "type": "activityFeed",
    "attributes": {
      "publicKey": "MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAJgL2/s97XHhA5rVSW5OfehDobeGN6O5tj+A1DkBwQySbmXcquwfMj5QohVKmKyvIJALKGiVTzANKh/ogXrDeNcCAwEAAQ==",
      "webhookUrl": "https://www.abc.com/webhook",
      "customHeaders": {
        "key": "value"
      }
    }
  }
}

Response

Response example

{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "totalResourceCount": 1
  },
  "data": {
    "id": "ce5cdfff-7818-455a-bc60-841be3513f4a",
    "type": "activityFeed",
    "attributes": {
      "webhookUrl": "****************************hook",
      "publicKey": "MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAJgL2/s97XHhA5rVSW5OfehDobeGN6O5tj+A1DkBwQySbmXcquwfMj5QohVKmKyvIJALKGiVTzANKh/ogXrDeNcCAwEAAQ==",
      "customHeaders": {
        "key": "value"
      }
    }
  }
}

Response codes

Status	Response	Description
201	Created	Your request was successful, and a new resource was created as a result. The URL to the new resource can be found in the Location header.
400	Bad request	The server couldn't understand your request, likely due to a syntax error or an invalid parameter.
401	Access denied request	Your request was rejected because it lacks valid authentication credentials. Check your API key and token.
403	Forbidden	You are not authorized to access this resource. While your credentials may be valid, you don't have the necessary permissions.
404	Not Found	The specific resource or endpoint you requested does not exist.
415	Unsupported Media Type	The server rejected your request because the data format `(Content-Type)` is not supported.
429	Too Many Requests	You've exceeded the rate limit by sending too many requests in a short period. The `Retry-After` header in the response will tell you how long to wait before trying again.
500	Internal Server Error	Something went wrong on the server's end. This is not an issue with your request.