lightyear.definewebhookprops

Home > @runlightyear/lightyear > DefineWebhookProps

DefineWebhookProps interface

Signature:

interface DefineWebhookProps 

Properties

Property	Modifiers	Type	Description
apps?		Array<AppName>	(Optional) An array of the system apps used by this webhook.
customApps?		Array<string>	(Optional) An array of the custom apps used by this webhook.
name		string	The name of this webhook.
receive?		ReceiveWebhookFunc	(Optional)
refreshSubscription?		RefreshSubscriptionFunc	(Optional)
secrets?		Array<SecretDef>	(Optional) An array of the secrets on this webhook. Secrets are like variables, but they are stored more securely in the database and they are redacted in the console logs. Secrets are required to have a value by default. If you append a "?" to the end of the name, the secret will be optional. For example: ["requiredSecret", "optionalSecret?"]
subscribe?		SubscribeFunc	(Optional)
subscribeProps?		SubscribePropsFunc	(Optional)
title		string	The title of this webhook.
unsubscribe?		UnsubscribeFunc	(Optional)
variables?		Array<VariableDef>	(Optional) An array of the variables on this webhook. Variables are required to have a value by default. If you append a "?" to the end of the name, the variable will be optional. For example: ["requiredVar", "optionalVar?"]