FRfrain-dev
Endpoints

Create an endpoint

Changed on

This endpoint creates an endpoint

post/v1/projects/{projectID}/endpoints

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    API key in header Authorization

Path parameters

projectIDstring required

Project ID

Request body

advanced_signaturesboolean

Convoy supports two signature formats -- simple or advanced. Only applies to outgoing projects, where it defaults to true when omitted. Incoming projects always use advanced signatures.

appIDstring

Deprecated but necessary for backward compatibility

content_typestring

Content type for the endpoint. Defaults to application/json if not specified.

descriptionstring

Human-readable description of the endpoint. Think of this as metadata describing the endpoint

http_timeoutinteger

Define endpoint http timeout in seconds.

is_disabledboolean

This is used to manually enable/disable the endpoint.

namestring

Endpoint name.

owner_idstring

The OwnerID is used to group more than one endpoint together to achieve fanout

rate_limitinteger

Rate limit is the total number of requests to be sent to an endpoint in the time duration specified in RateLimitDuration

rate_limit_durationinteger

Rate limit duration specifies the time range for the rate limit.

secretstring

Endpoint's webhook secret. If not provided, Convoy autogenerates one for the endpoint.

slack_webhook_urlstring

Slack webhook URL is an alternative method to support email where endpoint developers can receive failure notifications on a slack channel.

support_emailstring

Endpoint developers support email. This is used for communicating endpoint state changes. You should always turn this on when disabling endpoints are enabled.

teams_webhook_urlstring

Microsoft Teams webhook URL is an alternative method to support email where endpoint developers can receive failure notifications in a Teams channel. Use a Workflows (Power Automate) webhook URL; retired Office 365 connector URLs no longer deliver.

urlstring

URL is the endpoint's URL prefixed with https. non-https urls are currently not supported.

Response

Created

messagestring
statusboolean

Changes