Type Alias RestMessage

RestMessage: WithIdAndMetadata<
    {
        access?: "packagePrivate"
        | "public";
        description?: string;
        endpoint: string;
        functions?: RestMessageFn[];
        headers?: RestMessageHeader[];
        name: string;
    } & RestMessageAuth,
>

Defines an Outbound REST Message integration (sys_rest_message), including authentication, shared headers, and one or more HTTP method functions.

Param: config

an object containing the following properties:

$id - unique id for the record, typically using Now.ID["value"]
name - display name for the REST message
endpoint - base endpoint URL; variable substitution supported via ${varName}
description? - human-readable description
access? - 'packagePrivate' (default) or 'public'
authenticationType? - 'noAuthentication' (default) | 'basic' | 'oauth2'
basicAuthProfile? - sys_id of sys_auth_profile_basic (for authenticationType: 'basic')
oauthProfile? - sys_id of oauth_entity_profile (for authenticationType: 'oauth2')
headers? - shared headers applied to all functions
functions? - array of HTTP method functions; each defaults to authenticationType: 'inheritFromParent'

Type Alias RestMessage

Param: config

Settings