Variable CustomMessageTriggerSchema`Const`

CustomMessageTriggerSchema: ZodObject<
    {
        callerContext: ZodObject<
            { awsSdkVersion: ZodString; clientId: ZodString },
            $strip,
        >;
        region: ZodString;
        request: ZodObject<
            {
                clientMetadata: ZodOptional<ZodRecord<ZodString, ZodString>>;
                codeParameter: ZodString;
                linkParameter: ZodNullable<ZodString>;
                userAttributes: ZodRecord<ZodString, ZodString>;
                usernameParameter: ZodNullable<ZodString>;
            },
            $strip,
        >;
        response: ZodObject<
            {
                emailMessage: ZodNullable<ZodString>;
                emailSubject: ZodNullable<ZodString>;
                smsMessage: ZodNullable<ZodString>;
            },
            $strip,
        >;
        triggerSource: ZodString;
        userName: ZodOptional<ZodString>;
        userPoolId: ZodString;
        version: ZodString;
    },
    $strip,
> = ...

A zod schema for a Cognito Custom Message trigger event.

Example

{
  "version": "1",
  "triggerSource": "CustomMessage_SignUp",
  "region": "us-east-1",
  "userPoolId": "us-east-1_ABC123",
  "userName": "johndoe",
  "callerContext": {
    "awsSdkVersion": "2.814.0",
    "clientId": "client123"
  },
  "request": {
    "userAttributes": {
      "email": "user@example.com",
      "name": "John Doe"
    },
    "codeParameter": "{####}",
    "usernameParameter": "string",
    "linkParameter": "string",
    "usernameParameter": null
  },
  "response": {
    "smsMessage": null,
    "emailMessage": null,
    "emailSubject": null,
  }
}

See

Amazon Cognito Developer Guide

Variable CustomMessageTriggerSchemaConst

Example

See

Settings

Variable CustomMessageTriggerSchema`Const`