v51

latestSwagger 2.0Mozilla Public License 2.0raw.githubusercontent.com2026-08-0167151358.9 KB
Endpoints

Update an endpoint

This endpoint updates an endpoint

put/v1/projects/{projectID}/endpoints/{endpointID}

Path parameters

projectIDstring required

Project ID

endpointIDstring required

Endpoint ID

Request body

advanced_signaturesboolean

Convoy supports two signature formats -- simple or advanced. If left unspecified, we default to false.

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
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.

urlstring

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

Response

Accepted

messagestring
statusboolean