GEgetconvoy
Endpoints

Update an endpoint

Changed on

This endpoint updates an endpoint

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

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    HTTP bearer

Path parameters

projectIDstring required

Project ID

endpointIDstring required

Endpoint ID

Request body

advanced_signaturesboolean

Convoy supports two signature formats -- simple or advanced. Only applies to outgoing projects; omit it to keep the current value. Incoming projects always use advanced signatures.

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.

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

Accepted

messagestring
statusboolean

Changes

  • v3c6c04abdfb6fRevision changes
    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

  • v3bae289777c91Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      added the new enum value to the // response property for the response status

    • info

      added the new enum value to the request property /////

    • info

      added to the // response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status