Consumer

On This Page

The consumer module defines the resolver for the queue to process the async events. For more information about this feature, see async events.

Properties

Property Type Required Description

Property	Type	Required	Description
`key`	`string`	Yes	A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: `^[a-zA-Z0-9_-]+$`
`queue`	`string`	Yes	The name of the queue for which the resolver processes the events asynchronously.
`resolver`	`{ function: string }` or `{ endpoint: string }`	Yes	Set the `function` property if you are using a hosted `function` module for your resolver. Set the `endpoint` property if you are using Forge remote to integrate with a remote back end.

key

string

Yes

A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

queue

string

Yes

The name of the queue for which the resolver processes the events asynchronously.

resolver

{ function: string } or
{ endpoint: string }

Yes

Set the function property if you are using a hosted function module for your resolver.

Set the endpoint property if you are using Forge remote to integrate with a remote back end.