{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-custom-message-activity-schema.json", "title": "CustomMessageActivity", "description": "The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.", "type": "object", "properties": { "DeliveryUri": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "

The destination to send the campaign or treatment to. This value can be one of the following:

" } ] }, "EndpointTypes": { "allOf": [ { "$ref": "#/components/schemas/ListOf__EndpointTypesElement" }, { "description": "The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint." } ] }, "MessageConfig": { "allOf": [ { "$ref": "#/components/schemas/JourneyCustomMessage" }, { "description": "Specifies the message data included in a custom channel message that's sent to participants in a journey." } ] }, "NextActivity": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook." } ] }, "TemplateName": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template." } ] }, "TemplateVersion": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

" } ] } } }