---
updatedAt: 2025-02-27T21:12:19.000Z
agentTools:
  projectIndex: https://developers.atlas.so/llms.txt
---

# Create a webhook subscriptions

Create a webhook subscriptions

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Atlas API",
    "description": "Atlas API Documentation",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.atlas.so"
    }
  ],
  "paths": {
    "/v1/webhooks": {
      "post": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Create a webhook subscriptions",
        "description": "Create a webhook subscriptions",
        "operationId": "create_webhook_subscriptions_v1_webhooks_post",
        "security": [
          {
            "HTTPBearer": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExternalCreateWebhookSubscriptionSchema"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalReadWebhookSubscriptionSchema"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ExternalCreateWebhookSubscriptionSchema": {
        "properties": {
          "event": {
            "$ref": "#/components/schemas/WebhookEvent"
          },
          "endpoint": {
            "type": "string",
            "maxLength": 65536,
            "minLength": 1,
            "format": "uri",
            "title": "Endpoint",
            "examples": [
              "http://www.example.com/"
            ]
          }
        },
        "type": "object",
        "required": [
          "event",
          "endpoint"
        ],
        "title": "ExternalCreateWebhookSubscriptionSchema"
      },
      "ExternalReadWebhookSubscriptionSchema": {
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
          },
          "companyId": {
            "type": "string",
            "format": "uuid",
            "title": "Companyid"
          },
          "event": {
            "$ref": "#/components/schemas/WebhookEvent"
          },
          "endpoint": {
            "type": "string",
            "maxLength": 65536,
            "minLength": 1,
            "format": "uri",
            "title": "Endpoint",
            "examples": [
              "http://www.example.com/"
            ]
          },
          "endpointKey": {
            "type": "string",
            "title": "Endpointkey"
          },
          "status": {
            "$ref": "#/components/schemas/WebhookSubscriptionStatus"
          },
          "signingSecret": {
            "type": "string",
            "title": "Signingsecret"
          }
        },
        "type": "object",
        "required": [
          "id",
          "companyId",
          "event",
          "endpoint",
          "endpointKey",
          "status",
          "signingSecret"
        ],
        "title": "ExternalReadWebhookSubscriptionSchema"
      },
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "WebhookEvent": {
        "type": "string",
        "enum": [
          "account.created",
          "account.updated",
          "account.customer.linked",
          "account.customer.unlinked",
          "conversation.created",
          "conversation.agent",
          "conversation.tags",
          "conversation.custom_fields",
          "conversation.status",
          "conversation.priority",
          "conversation.message",
          "conversation.message.deprecated",
          "customer.identify",
          "customer.created",
          "customer.updated",
          "customer.custom_fields",
          "customer.notes",
          "customer.notes.deleted",
          "session.finished",
          "sidebar.sent",
          "sidebar.received"
        ],
        "title": "WebhookEvent"
      },
      "WebhookSubscriptionStatus": {
        "type": "string",
        "enum": [
          "ACTIVE",
          "INACTIVE"
        ],
        "title": "WebhookSubscriptionStatus"
      }
    },
    "securitySchemes": {
      "HTTPBearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}
```