---
title: "POST /event-forwarder-create-webhook"
method: POST
path: "/event-forwarder-create-webhook"
tags: ["v2"]
---

# POST /event-forwarder-create-webhook

`POST /event-forwarder-create-webhook`

## Request body

- EventForwarderCreateWebhook — eventForwarderCreateWebhook is a command that creates webhook event forwarder
  - `auth-methods-event-source-locations` string[] — Auth Method Event sources
  - `auth-token` string — Base64 encoded Token string for authentication type Token
  - `auth-type` string — The Webhook authentication type [user-pass, bearer-token, certificate]
  - `client-cert-data` string — Base64 encoded PEM certificate, relevant for certificate auth-type
  - `description` string — Description of the object
  - `event-types` string[] — 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]
  - `every` string — Rate of periodic runner repetition in hours
  - `gateways-event-source-locations` string[], required — Event sources
  - `items-event-source-locations` string[] — Items Event sources
  - `json` boolean — Set output format to JSON
  - `key` string — The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
  - `name` string, required — EventForwarder name
  - `password` string — Password for authentication relevant for user-pass auth-type
  - `private-key-data` string — Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
  - `runner-type` string, required
  - `server-certificates` string — Base64 encoded PEM certificate of the Webhook
  - `targets-event-source-locations` string[] — Targets Event sources
  - `token` string — Authentication token (see `/auth` and `/configure`)
  - `uid-token` string — The universal identity token, Required only for universal_identity authentication
  - `url` string — Webhook URL
  - `username` string — Username for authentication relevant for user-pass auth-type

## Response `201`

eventForwarderCreateWebhookResponse wraps response body.

- EventForwarderCreateUpdateOutput
  - `event_forwarder_id` integer
  - `event_forwarder_name` string

## Other responses

- `default` — errorResponse wraps any error to return it as a JSON object with one "error" field.

---

[API](https://skmtc.net/akeyless/apis/akeyless-api.md) · [All operations](https://skmtc.net/akeyless/apis/akeyless-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/akeyless/akeyless-api/versions/0ceb25634501/schema)
