# Create a hook

**POST /api/hooks**

Create a new hook with the given data.


## Servers
- Logto endpoint address.: https://[tenant_id].logto.app (Logto endpoint address.)


## Authentication methods
- OAuth2


## Parameters



### Body: application/json (object)

- **tenantId** (string)

- **name** (string)
  The name of the hook.
- **event** (string)
  Use `events` instead.
- **events** (array[string])
  An array of hook events.
- **config** (object)

- **enabled** (boolean)

- **createdAt** (number)



## Responses
### 201
The hook was created successfully.

#### Body: application/json (object)
- **tenantId** (string)

- **id** (string)

- **name** (string)

- **event** (string | null)

- **events** (array[string])

- **config** (object)

- **signingKey** (string)

- **enabled** (boolean)

- **createdAt** (number)


### 400
Bad Request

### 401
Unauthorized

### 403
Forbidden


[Powered by Bump.sh](https://bump.sh)