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

# POST /create-event-forwarder

`POST /create-event-forwarder`

## Request body

- CreateEventForwarder — createEventForwarder is a command that creates a new event forwarder [Deprecated - please use event-forwarder-create-* command]
  - `admin-name` string — Workstation Admin Name
  - `admin-pwd` string — Workstation Admin password
  - `app-private-key-base64` string — The RSA Private Key PEM formatted in base64 to use when connecting to ServiceNow with jwt authentication
  - `auth-type` string — The authentication type to use when connecting to ServiceNow (user-pass / jwt)
  - `client-id` string — The client ID to use when connecting to ServiceNow with jwt authentication
  - `client-secret` string — The client secret to use when connecting to ServiceNow with jwt authentication
  - `comment` string — Deprecated - use description
  - `description` string — Description of the object
  - `email-to` string — A comma seperated list of email addresses to send event to (relevant only for "email" Event Forwarder)
  - `event-source-locations` string[], required — Event sources
  - `event-source-type` string — Event Source type [item, target, auth_method, gateway]
  - `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, 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]
  - `every` string — Rate of periodic runner repetition in hours
  - `forwarder-type` string, required
  - `host` string — Workstation Host
  - `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
  - `runner-type` string, required
  - `token` string — Authentication token (see `/auth` and `/configure`)
  - `uid-token` string — The universal identity token, Required only for universal_identity authentication
  - `user-email` string — The user email to use when connecting to ServiceNow with jwt authentication

## Response `200`

createEventForwarderResponse wraps response body.

- CreateEventForwarderOutput
  - `event_forwarder_id` integer

## 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)
