Create an endpoint
This endpoint creates an endpoint
Authorizations
Path Parameters
Project ID
Body
Convoy supports two signature formats -- simple or advanced. If left unspecified, we default to false.
Deprecated but necessary for backward compatibility
This is used to define any custom authentication required by the endpoint. This shouldn't be needed often because webhook endpoints usually should be exposed to the internet.
Human-readable description of the endpoint. Think of this as metadata describing the endpoint
Define endpoint http timeout in seconds.
This is used to manually enable/disable the endpoint.
Endpoint name.
The OwnerID is used to group more than one endpoint together to achieve fanout
Rate limit is the total number of requests to be sent to an endpoint in the time duration specified in RateLimitDuration
Rate limit duration specifies the time range for the rate limit.
Endpoint's webhook secret. If not provided, Convoy autogenerates one for the endpoint.
Slack webhook URL is an alternative method to support email where endpoint developers can receive failure notifications on a slack channel.
Endpoint developers support email. This is used for communicating endpoint state changes. You should always turn this on when disabling endpoints are enabled.
URL is the endpoint's URL prefixed with https. non-https urls are currently not supported.
Response
Was this page helpful?