API Reference
    Preparing search index...

    Variable APIGatewayProxyWebsocketEventSchemaConst

    APIGatewayProxyWebsocketEventSchema: ZodObject<
        {
            body: ZodNullable<ZodOptional<ZodString>>;
            headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>;
            isBase64Encoded: ZodBoolean;
            methodArn: ZodString;
            multiValueHeaders: ZodRecord<ZodString, ZodArray<ZodString>>;
            multiValueQueryStringParameters: ZodNullable<
                ZodRecord<ZodString, ZodArray<ZodString>>,
            >;
            queryStringParameters: ZodNullable<ZodRecord<ZodString, ZodString>>;
            requestContext: ZodObject<
                {
                    apiId: ZodString;
                    connectedAt: ZodNumber;
                    connectionId: ZodString;
                    domainName: ZodString;
                    eventType: ZodEnum<
                        { CONNECT: "CONNECT"; DISCONNECT: "DISCONNECT"; MESSAGE: "MESSAGE" },
                    >;
                    extendedRequestId: ZodString;
                    identity: ZodObject<
                        { sourceIp: ZodString; userAgent: ZodOptional<ZodString> },
                        $strip,
                    >;
                    messageDirection: ZodEnum<{ IN: "IN"; OUT: "OUT" }>;
                    requestId: ZodString;
                    requestTime: ZodString;
                    requestTimeEpoch: ZodNumber;
                    routeKey: ZodString;
                    stage: ZodString;
                },
                $strip,
            >;
            stageVariables: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>;
            type: ZodString;
        },
        $strip,
    > = ...

    A zod schema for API Gateway Proxy WebSocket events.

    {
      "type": "REQUEST",
      "methodArn": "arn:aws:execute-api:us-east-1:123456789012:abcdef123/default/$connect",
      "headers": {
        "Connection": "upgrade",
        "content-length": "0",
        "HeaderAuth1": "headerValue1",
        "Host": "abcdef123.execute-api.us-east-1.amazonaws.com",
        "Sec-WebSocket-Extensions": "permessage-deflate; client_max_window_bits",
        "Sec-WebSocket-Key": "...",
        "Sec-WebSocket-Version": "13",
        "Upgrade": "websocket",
        "X-Amzn-Trace-Id": "..."
      },
      "multiValueHeaders": {
        "Connection": [ "upgrade" ],
        "content-length": [ "0" ],
        "HeaderAuth1": [ "headerValue1" ],
        "Host": [ "abcdef123.execute-api.us-east-1.amazonaws.com" ],
        "Sec-WebSocket-Extensions": [ "permessage-deflate; client_max_window_bits" ],
        "Sec-WebSocket-Key": [ "..." ],
        "Sec-WebSocket-Version": [ "13" ],
        "Upgrade": [ "websocket" ],
        "X-Amzn-Trace-Id": [ "..." ]
      },
      "queryStringParameters": {
        "QueryString1": "queryValue1"
      },
      "multiValueQueryStringParameters": {
        "QueryString1": [ "queryValue1" ]
      },
      "stageVariables": {},
      "requestContext": {
        "routeKey": "$connect",
        "eventType": "CONNECT",
        "extendedRequestId": "...",
        "requestTime": "19/Jan/2023:21:13:26 +0000",
        "messageDirection": "IN",
        "stage": "default",
        "connectedAt": 1674162806344,
        "requestTimeEpoch": 1674162806345,
        "identity": {
          "sourceIp": "..."
        },
        "requestId": "...",
        "domainName": "abcdef123.execute-api.us-east-1.amazonaws.com",
        "connectionId": "...",
        "apiId": "abcdef123"
      },
      "isBase64Encoded": false,
      "body": null
    }

    Settings

    Member Visibility