ExternalApiData: {
    action: string;
    body: Record<string, string>;
    header: Record<string, string>;
    parameter: Record<string, string>;
    query: Record<string, string>;
    raw: string;
    sendAsForm: boolean;
    source: string;
}

Configuration object for an external API request.

Type declaration

  • action: string

    The name of the action to use.

  • body: Record<string, string>

    The body for basic form posts and JSON posts.

  • header: Record<string, string>

    The key value pairs of all headers to use. Note some additional headers may be injected and may overwrite existing headers.

  • parameter: Record<string, string>

    Url parameter can be used to replace variable parts within the URL.

  • query: Record<string, string>

    The query parameters to use.

  • raw: string

    The raw body to send. If set, the body will be ignored.

  • sendAsForm: boolean

    Flag indicating if we should send the body as a form or as JSON. Used only when the body is set and raw is not set.

  • source: string

    The name of the source to use.

Generated using TypeDoc