lightyear.definewebhookprops
Home > @runlightyear/lightyear > DefineWebhookProps
DefineWebhookProps interface
Signature:interface DefineWebhookProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| name | string | The name of this webhook. | |
| title | string | The title of this webhook. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| apps? | Array<AppName> | An array of the system apps used by this webhook. | |
| customApps? | Array<string> | An array of the custom apps used by this webhook. | |
| receive? | ReceiveWebhookFunc | ||
| refreshSubscription? | RefreshSubscriptionFunc | ||
| secrets? | Array<SecretDef> | 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 | ||
| subscribeProps? | SubscribePropsFunc | ||
| unsubscribe? | UnsubscribeFunc | ||
| variables? | Array<VariableDef> | 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?"] |