---
title: "Create Webhook"
method: POST
path: "/hooks"
tags: ["Webhooks"]
---

# Create Webhook

`POST /hooks`

## Request

- Base URL: `https://api.forcemanager.com/api/v4`
- URL: `https://api.forcemanager.com/api/v4/hooks`
- Auth: API key in header `X-Session-Key`

This endpoint allows you to create an Webhook based on JSON input.

You will only be able to create an Webhook after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).

**HEADERS**

| **Parameter** | **Value** | **Description** |
| --- | --- | --- |
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | \*/\* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |

**REQUEST BODY**

| **Attribute** | **Type** | **Description** |
| --- | --- | --- |
| action (_Required_) | String | The values can be: `insert`, `update` or `delete` |
| entity (_Required_) | String | The values can be: `account`, `contact`, `opportunity`, `activity`, `calendar`, `salesorder` |
| name (_Required_) | String | The name of the Webhook |
| url (_Required_) | String | The endpoint of the Webhook |
| version | String | The Webhook version |

**RESPONSE**

| **Attribute** | **Type** | **Description** |
| --- | --- | --- |
| id | Integer | Id assigned to the new Webhook |
| Message | String | Shows the operation status |

**RESPONSE CODES**

| **Status** | **Description** |
| --- | --- |
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |

## Headers

- `Accept` string

## Request body

- object
  - `name` string
  - `action` string
  - `entity` string
  - `url` string

## Response `200`

Create Webhook

---

[API](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer.md) · [All operations](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/llms.txt) · [OpenAPI document](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/revisions/87db17204e2f?raw)