---
updatedAt: 2025-06-16T20:34:53.000Z
agentTools:
  projectIndex: https://developers.manatal.com/llms.txt
---

# Create Webhook

Register a new webhook

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "title": "Manahook",
    "description": "Manahook Open API documentation and API reference",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "manahook.api.manatal.com/v1"
    }
  ],
  "paths": {
    "/webhooks/": {
      "post": {
        "tags": [
          "webhooks"
        ],
        "summary": "Create Webhook",
        "description": "Register a new webhook",
        "operationId": "create_webhook_v1_webhooks__post",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookRegister"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookReturn"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          },
          "422": {
            "description": "Unprocessable Entity"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "EventAction": {
        "title": "EventAction",
        "enum": [
          "create",
          "update",
          "moved",
          "status_update"
        ],
        "type": "string",
        "description": "An enumeration. When model is match, allowed values are create and moved. When model is candidate or contact, allowed values are create and update. When model is job, allowed value is status_update."
      },
      "ManatalModels": {
        "title": "ManatalModels",
        "enum": [
          "candidate",
          "contact",
          "match",
          "job"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "WebhookRegister": {
        "title": "WebhookRegister",
        "required": [
          "model",
          "action",
          "target_url"
        ],
        "type": "object",
        "properties": {
          "model": {
            "$ref": "#/components/schemas/ManatalModels"
          },
          "action": {
            "$ref": "#/components/schemas/EventAction"
          },
          "target_url": {
            "title": "Target Url",
            "maxLength": 65536,
            "minLength": 1,
            "type": "string",
            "format": "uri"
          }
        },
        "description": "Schema for receiving creating webhook request"
      },
      "WebhookReturn": {
        "title": "WebhookReturn",
        "required": [
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "integer"
          }
        },
        "description": "Schema for returning only id"
      }
    },
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "x-default": "Token "
      }
    }
  },
  "security": [
    {
      "api_key": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```