IWebhookDestinationConfiguration
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
export interface IWebhookDestinationConfiguration
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (BETA) (Optional) URL of the webhook endpoint. | ||
boolean | (BETA) (Optional) Flag indicating whether the webhook has a stored signing secret. | ||
boolean | (BETA) (Optional) Flag indicating whether the webhook has setup a token. | ||
string | (BETA) (Optional) Optional shared secret used to sign outgoing webhooks. An empty string disables signing. Omit the value and set | ||
string | (BETA) (Optional) Optional bearer token. An empty string disables bearer authentication. |
Property details
IWebhookDestinationConfiguration.endpointpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
URL of the webhook endpoint.
endpoint?: string;
IWebhookDestinationConfiguration.hasSecretKeypropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Flag indicating whether the webhook has a stored signing secret.
hasSecretKey?: boolean;
IWebhookDestinationConfiguration.hasTokenpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Flag indicating whether the webhook has setup a token.
hasToken?: boolean;
IWebhookDestinationConfiguration.secretKeypropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Optional shared secret used to sign outgoing webhooks. An empty string disables signing. Omit the value and set hasSecretKey to true to preserve a stored secret when updating the channel.
secretKey?: string;
IWebhookDestinationConfiguration.tokenpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Optional bearer token. An empty string disables bearer authentication.
token?: string;