Skip to content
/
Settings updated via API

Settings updated via API
Webhook

Request

A team's settings were updated via the settings API.

Security
X-Signature
Headers
X-Signaturestringrequired
Example:X-Signature: t=1492774577,v1=5257a869...
Bodyapplication/json
versionstringrequired

The version of the event.

Example:"1"
idstring, (uuid)required

The unique identifier for the event. This can be used as an idempotency key.

Example:"c478966c-f927-411c-b919-179832d3d50c"
timestampintegerrequired

When the event occurred, formatted as a UNIX timestamp (in seconds).

Example:1698604061
categorystringrequired

The category of the event.

Value:"AUDIT"
objectstringrequired

The type of event.

Value:"SETTINGS_UPDATED_VIA_API"
friendlyNamestringrequired

The friendly name of this object. Note: this is subject to change and should not be used to match on this object.

Example:"Settings updated via API"
descriptionstringrequired

The description of the event. Note: this is subject to change and should not be used to match on this object.

Example:"API key (Write API key) updated the settings"
actorobject(Admin Audit Log Actor API)required

This object contains details about the API key used in the API request that triggered the audit log.

newobjectrequired

The full settings configuration after the update, in the same shape returned by the settings API.

oldobjectrequired

The full settings configuration before the update, in the same shape returned by the settings API.

POST
settings-updated-via-api
Payload
{
  "version": "1",
  "id": "c478966c-f927-411c-b919-179832d3d50c",
  "timestamp": 1698604061,
  "category": "AUDIT",
  "object": "SETTINGS_UPDATED_VIA_API",
  "friendlyName": "Settings updated via API",
  "description": "API key (Write API key) updated the settings",
  "actor": {
    "source": "API",
    "apiKeyName": "string",
    "apiKeyCreatedBy": "string",
    "sourceIpAddress": "string",
    "userAgent": "string"
  },
  "new": {},
  "old": {}
}

Responses

Return any 2XX status to indicate that the data was received successfully