---
title: "Create an endpoint"
method: POST
path: "/v1/projects/{projectID}/endpoints"
tags: ["Endpoints"]
---

# Create an endpoint

`POST /v1/projects/{projectID}/endpoints`

This endpoint creates an endpoint

## Path parameters

- `projectID` string, required

## Request body

- ModelsCreateEndpoint
  - `advanced_signatures` boolean — Convoy supports two [signature formats](https://getconvoy.io/docs/manual/signatures) -- simple or advanced. If left unspecified, we default to false.
  - `appID` string — Deprecated but necessary for backward compatibility
  - `authentication` ModelsEndpointAuthentication
    - `api_key` ModelsApiKey
      - `header_name` string, required
      - `header_value` string, required
    - `type` 'api_key'
  - `description` string — Human-readable description of the endpoint. Think of this as metadata describing the endpoint
  - `http_timeout` integer — Define endpoint http timeout in seconds.
  - `is_disabled` boolean — This is used to manually enable/disable the endpoint.
  - `name` string — Endpoint name.
  - `owner_id` string — The OwnerID is used to group more than one endpoint together to achieve [fanout](https://getconvoy.io/docs/manual/endpoints#Endpoint%20Owner%20ID)
  - `rate_limit` integer — Rate limit is the total number of requests to be sent to an endpoint in the time duration specified in RateLimitDuration
  - `rate_limit_duration` integer — Rate limit duration specifies the time range for the rate limit.
  - `secret` string — Endpoint's webhook secret. If not provided, Convoy autogenerates one for the endpoint.
  - `slack_webhook_url` string — Slack webhook URL is an alternative method to support email where endpoint developers can receive failure notifications on a slack channel.
  - `support_email` string — Endpoint developers support email. This is used for communicating endpoint state changes. You should always turn this on when disabling endpoints are enabled.
  - `url` string — URL is the endpoint's URL prefixed with https. non-https urls are currently not supported.

## Response `201`

Created

- object
  - `message` string
  - `status` boolean
  - `data` ModelsEndpointResponse
    - `advanced_signatures` boolean
    - `authentication` DatastoreEndpointAuthentication
      - `api_key` DatastoreApiKey
        - `header_name` string
        - `header_value` string
      - `type` 'api_key'
    - `created_at` string
    - `deleted_at` string
    - `description` string
    - `events` integer
    - `failure_rate` number
    - `http_timeout` integer
    - `name` string
    - `owner_id` string
    - `project_id` string
    - `rate_limit` integer
    - `rate_limit_duration` integer
    - `secrets` DatastoreSecret[]
      - `created_at` string
      - `deleted_at` string
      - `expires_at` string
      - `uid` string
      - `updated_at` string
      - `value` string
    - `slack_webhook_url` string
    - `status` 'active' | 'inactive' | 'pending' | 'paused'
    - `support_email` string
    - `uid` string
    - `updated_at` string
    - `url` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

## Changes

- **2024-10-23** (v3) `de665d0e2fc3` — 2 breaking, 1 info
  - the request property `authentication/allOf[#/components/schemas/models.EndpointAuthentication]/api_key/header_name` became required
  - the request property `authentication/allOf[#/components/schemas/models.EndpointAuthentication]/api_key/header_value` became required
  - added the optional property `allOf[subschema #2]/data/failure_rate` to the response with the `201` status
- **2024-07-12** (v3) `59336767e79a` — 1 breaking, 1 info
  - removed the success response with the status `200`
  - added the success response with the status `201`
- **2024-03-26** (v3) `28d285e4302c` — 6 warning, 3 info
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `200` status
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `400` status
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `401` status
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `404` status
  - …5 more
- …earlier changes not shown

[Full history](https://skmtc.dev/getconvoy/apis/convoy-api-reference/changes/v1/projects/:projectID/endpoints/post.md)

---

[API](https://skmtc.dev/getconvoy/apis/convoy-api-reference.md) · [All operations](https://skmtc.dev/getconvoy/apis/convoy-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getconvoy/convoy-api-reference/revisions/de665d0e2fc3/schema)