---
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
      - `header_value` string
    - `type` 'api_key'
  - `description` string — Human readable description of the endpoint. Think of this as metadata describing the endpoint
  - `http_timeout` string — Define endpoint http timeout in seconds. It uses Go's time duration syntax. E.g. 3s, 1m
  - `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` string — Rate limit duration specifies the time range for the rate limit. It uses Go's time duration syntax. E.g. 3s, 1m
  - `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.
  - `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.

## Changes

- **2023-11-27** (v3) `47c7286b8cee` — 2 breaking, 2 warning
  - added `#/components/schemas/models.EndpointAuthentication` to the `authentication` request property `allOf` list
  - the `authentication` request property type/format changed from `object`/`` to ``/``
  - removed the request property `authentication/api_key`
  - removed the request property `authentication/type`

[Change 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/bbe11224b60e/schema)