v1

latestOpenAPI 3.0.1Gremlin License2026-08-06397451577.0 KB

webhooks

Create a webhook

Requires the privilege WEBHOOKS_WRITE

post/webhooks

teamIdstring required

Required when using company session token.

identifierstring

The identifier of this webhook

namestring required

The name of the webhook to be created/updated

descriptionstring

The description of the webhook to be created/updated

isPrivateNetworkboolean

uristring url required

The URI of the webhook

method'GET' | 'POST' | 'PUT' | 'PATCH' required

The HTTP request method to use when the webhook is invoked

headersobject

Optional request headers to be used when the webhook is invoked

triggerEventsstring[]

The list of attack events that should cause the webhook to be invoked

state'ACTIVE' | 'DEACTIVATED'

State (active/deactivated) of the webhook

payloadstring

The payload to be sent when the webhook is invoked

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

The type of this webhook

multiSelectTagsobject

The tags associated with this webhook

default response