Browse Docs

Configuring API Callback Notifications

Overview

API callback notifications require an API endpoint implementation on your side.

The supported events described below are serialized as JSON and sent to API endpoint that is implemented on your environment via HTTP POST request.

Request Format

The request content-type will be application/json and only a single endpoint was used to make the integration process on the partner’s system easy.

Every request body contains the following object members:

Member Description

event

Type of the event

time

Event creation time in Unix timestamp format

payload

Related object based on the event type

Event Types

Following event types are supported:

Event Type Description

Agent.Create

It is fired when a new Desktop agent created on the system

Agent.Uninstall

It is fired when the agent uninstalled

Agent.Reinstall

It is fired if the agent reinstalled on the same computer

Agent.Delete

It is fired after the agent destroys

UserRequest.Create

It is fired after a user request is submitted through the DefensX extension

A sample request body for the Agent.Create event:

{
    "event": "Agent.Create",
    "time": 1677237885,
    "payload": {
        "type": "Agent",
        "id": "fdceb72a-c274-4844-8b74-a0c74a8018e5",
        "deployment_id": "bef7a5bd-a653-46b8-b95c-a59dcedcbafe",
        "customer_id": "c062a202-e090-4e57-ba88-d74dfd2e3455",
        "platform": "Windows",
        "product": "Windows 10 Pro",
        "hostname": "WIN10-4",
        "version": "1.8.78"
    }
}

A sample request body for the UserRequest.Create event:

{
    "event": "UserRequest.Create",
    "time": 1677241081,
    "payload": {
        "type": "UserRequest",
        "id": 1650,
        "user_id": "ab02c0d0-f02f-4e9f-8fd6-dc82ea142c63",
        "customer_id": "c062a202-e090-4e57-ba88-d74dfd2e3455",
        "report_type": "url_block",
        "hostname": "monster.com",
        "url": "https:\/\/monster.com\/",
        "reason": "Incorrect Risk Rating"
    }
}