Class Webhook

constructor

• new Webhook(name, url): Webhook

• Parameters

  • name: string

    The name of the webhook.
  • url: string

    The URL of the webhook.

  Returns Webhook

enabled

messageFormat

name

optionalHeaders

url

webhookTriggers

addOptionalHeader

• addOptionalHeader(name, value): Webhook

• Adds an optional header to the webhook.

  Parameters

  • name: string

    The header name.
  • value: string

    The header value.

  Returns Webhook

  The current Webhook instance for method chaining.

setEnabled

• setEnabled(enabled): Webhook

• Sets whether the webhook is enabled.

  Parameters

  • enabled: boolean

    The enabled state.

  Returns Webhook

  The current Webhook instance for method chaining.

setMessageFormat

• setMessageFormat(format): Webhook

• Sets the message format.

  Parameters

  • format: number

    The message format (0 for JSON, 1 for XML).

  Returns Webhook

  The current Webhook instance for method chaining.

setName

• setName(name): Webhook

• Sets the name of the webhook.

  Parameters

  • name: string

    The new name.

  Returns Webhook

  The current Webhook instance for method chaining.

setUrl

• setUrl(url): Webhook

• Sets the URL of the webhook.

  Parameters

  • url: string

    The new URL.

  Returns Webhook

  The current Webhook instance for method chaining.

setWebhookTriggers

• setWebhookTriggers(triggers): Webhook

• Sets the triggers for the webhook.

  Parameters

  • triggers: WebhookTrigger[]

    The list of triggers.

  Returns Webhook

  The current Webhook instance for method chaining.

toJSON

• toJSON(): object

• Converts the Webhook instance to a JSON object for the API.

  Returns object

  The JSON representation of the Webhook.