v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/event-forwarder-create-webhook

Request body

auth-methods-event-source-locationsstring[]

Auth Method Event sources

auth-tokenstring

Base64 encoded Token string for authentication type Token

auth-typestring

The Webhook authentication type [user-pass, bearer-token, certificate]

client-cert-datastring

Base64 encoded PEM certificate, relevant for certificate auth-type

descriptionstring

Description of the object

event-typesstring[]

List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]

everystring

Rate of periodic runner repetition in hours

gateways-event-source-locationsstring[] required

Event sources

items-event-source-locationsstring[]

Items Event sources

jsonboolean

Set output format to JSON

keystring

The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)

namestring required

EventForwarder name

passwordstring

Password for authentication relevant for user-pass auth-type

private-key-datastring

Base64 encoded PEM RSA Private Key, relevant for certificate auth-type

runner-typestring required
server-certificatesstring

Base64 encoded PEM certificate of the Webhook

targets-event-source-locationsstring[]

Targets Event sources

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

urlstring

Webhook URL

usernamestring

Username for authentication relevant for user-pass auth-type

Response

eventForwarderCreateWebhookResponse wraps response body.

event_forwarder_idinteger
event_forwarder_namestring