salesforce-platform-events-definitions v0.2.0

Salesforce Platform Events Definitions

This repository allows us to define and deploy Platform Events Definitions into Salesforce. Anyone can contribute, but it is really important to follow the guidelines: https://loftbr.atlassian.net/wiki/spaces/OPTS/pages/1203994726/Eventos

Creating a new Platform Event Definition

To create a new Platform Event Definition, you just have to copy the file from sample folder to package/objects and change it to the definition you want.

Event

out

• Optional out: boolean

• default: false

api_name

• api_name: string

name

• Optional name: string

description

• Optional description: string

fields

• fields: Field[]

Field

api_name

• api_name: string

description

• Optional description: string

name

• Optional name: string

required

• Optional required: boolean

type

• type: FieldsType

Type aliases

FieldsType

Ƭ FieldsType: "Text" | "LongTextArea" | "Number" | "Checkbox" | "Date" | "DateTime"

Input or Output event

If you are creating an output event, it's api_name must starts with "Out". Otherwise, if the event is Input, it's name MUST NOT starts with "Out".

Output event

If you want to control the group id of fifo output queue, you should add the GroupId in your event as the sample do.

Deprecating

If something does not make sense anymore, the first step is speak with all teams that uses the event and/or field to be deprecated and make sure they do not need it anymore. After that, you must add DEPRECATED in name of the event and/or event field.