---
title: "Add a new webhook"
method: POST
path: "/api/v2/organizations/{orgSlug}/webhooks"
tags: ["Webhooks"]
---

# Add a new webhook

`POST /api/v2/organizations/{orgSlug}/webhooks`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/webhooks`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.settings.webhooks.create`

Add a new webhook 

 Required scopes: `flex.settings.webhooks.create`

## Path parameters

- `orgSlug` string, required

## Request body

- AddWebhookDto
  - `eventTypes` string[], required: An array containg the type of events associated with the webhook.
  - `url` string, required: The URL of the endpoint of your server where POST requests will be made.
  - `description` string: A description of the webhook.
  - `isEnabled` boolean: Determines whether the webhook is enabled. If left empty the webhook will be turned on by default.

## Response `201`

- WebhookResultDto
  - `_id` string: The _id of the webhook.
  - `url` string: The URL of the endpoint of your server where POST requests will be made.
  - `description` string: A description of the webhook.
  - `eventTypes` string[]: An array containg the type of events associated with the webhook.
  - `secret` string: The secret key used to sign the webhook payload.
  - `isEnabled` boolean: Determines whether the webhook is enabled. If left empty the webhook will be turned on by default.

---

[API](https://skmtc.dev/officernd/apis/settings-api.md) - [All operations](https://skmtc.dev/officernd/apis/settings-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/settings-api/revisions/656d8878f9e2?raw)