Sign in

v1

latestOpenAPI 3.0.1Gremlin License2026-08-06397451577.0 KB
webhooks

Requires the privilege WEBHOOKS_READ

get/webhooks

Query parameters

state'ACTIVE' | 'DEACTIVATED'

Filter webhooks by state

teamIdstring required

Required when using company session token.

Response

default response

teamIdstring

The identifier of the team to which this webhook belongs

identifierstring

The identifier of this webhook

type'TASK' | 'STATUS_CHECK' | 'LOAD_GENERATOR_TRIGGER' | 'LOAD_GENERATOR_STATUS_CHECK' | 'PREREQUISITE'

The type of this webhook

namestring

The name of this webhook

descriptionstring

The description of this webhook

createdBystring

The identifier of the user that created this webhook

createdAtstring date-time

The time of creation of this webhook

updatedBystring

The identifier of the user that most recently updated this webhook (if applicable)

updatedAtstring date-time

The time of the most recent update for this webhook (if applicable)

isPrivateNetworkboolean

Is this webhook executed in a private network

triggerEventsstring[]

The types of events that will trigger this webhook to fire

state'ACTIVE' | 'DEACTIVATED'

The state of this webhook (ACTIVE / DEACTIVATED

payloadstring

The payload to be sent when the webhook is invoked

multiSelectTagsobject

The tags associated with this webhook