Interface WebhookEvent

Base model of an event (e.g. webhook or email)

interface WebhookEvent {
    basicAuth?: {
        password?: string;
        username?: string;
    };
    body?: any;
    bodyMapping?: string;
    checkpoint?: string;
    contentType?: string;
    method?: "get" | "post" | "patch" | "delete" | "put";
    suppressMultipleExecutions?: boolean;
    type: webhook;
    url?: string;
}

Hierarchy (view full)

Properties

basicAuth? body? bodyMapping? checkpoint? contentType? method? suppressMultipleExecutions? type url?

Properties

Optional basicAuth

basicAuth?: {
    password?: string;
    username?: string;
}

Type declaration

  • Optional password?: string
  • Optional username?: string

Optional body

body?: any

Optional bodyMapping

bodyMapping?: string

mapping in JSONATA format (https://www.npmjs.com/package/jsonata)

Optional checkpoint

checkpoint?: string

Optional contentType

contentType?: string

Optional method

method?: "get" | "post" | "patch" | "delete" | "put"

Optional suppressMultipleExecutions

suppressMultipleExecutions?: boolean

type

type: webhook

Optional url

url?: string

Settings

Member Visibility

Theme

On This Page

basicAuthbodybodyMappingcheckpointcontentTypemethodsuppressMultipleExecutionstypeurl