import { ModelsUpdateEndpoint } from "convoy.js/models";
let value: ModelsUpdateEndpoint = {};| Field | Type | Required | Description |
|---|---|---|---|
advancedSignatures |
boolean | ➖ | 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. |
authentication |
models.ModelsEndpointAuthentication | ➖ | 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. |
contentType |
string | ➖ | Content type for the endpoint. Defaults to application/json if not specified. |
description |
string | ➖ | Human-readable description of the endpoint. Think of this as metadata describing the endpoint |
httpTimeout |
number | ➖ | Define endpoint http timeout in seconds. |
isDisabled |
boolean | ➖ | This is used to manually enable/disable the endpoint. |
mtlsClientCert |
models.ModelsMtlsClientCert | ➖ | mTLS client certificate configuration for the endpoint |
name |
string | ➖ | N/A |
ownerId |
string | ➖ | The OwnerID is used to group more than one endpoint together to achieve fanout |
rateLimit |
number | ➖ | Rate limit is the total number of requests to be sent to an endpoint in the time duration specified in RateLimitDuration |
rateLimitDuration |
number | ➖ | Rate limit duration specifies the time range for the rate limit. |
secret |
string | ➖ | Endpoint's webhook secret. If not provided, Convoy autogenerates one for the endpoint. |
slackWebhookUrl |
string | ➖ | Slack webhook URL is an alternative method to support email where endpoint developers can receive failure notifications on a slack channel. |
supportEmail |
string | ➖ | Endpoint developers support email. This is used for communicating endpoint state changes. You should always turn this on when disabling endpoints are enabled. |
teamsWebhookUrl |
string | ➖ | 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. |
url |
string | ➖ | URL is the endpoint's URL prefixed with https. non-https urls are currently not supported. |