Platform Event Schema by Event Name
GET {{_endpoint}}/services/data/v{{version}}/sobjects/:EVENT_NAME/eventSchema
Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
payloadFormat | null | (Optional query parameter. Available in API version 43.0 and later.) The format of the returned event schema. This parameter can take one of the following values. | |
| EXPANDED—The JSON representation of the event schema, which is the default format when payloadFormat is not specified in API version 43.0 and later. | |||
| COMPACT—A format that adheres to the open-source Apache Avro specification for the record complex type (see Apache Avro Format). Subscribers use the compact schema format to deserialize compact events received in binary form. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"name":"Sample__e","namespace":"com.sforce.eventbus","type":"expanded-record","fields":[{"name":"data","type":{"type":"record","name":"Data","namespace":"","fields":[{"name":"schema","type":"string"},{"name":"payload","type":{"type":"record","name":"Payload","doc":"","fields":[{"name":"CreatedDate","type":"string","doc":"CreatedDate:DateTime"},{"name":"CreatedById","type":"string","doc":"CreatedBy:EntityId"},{"name":"Message__c","type":["null","string"],"doc":"Data:Text:00N4H00000Ecs0G","default":null}]}},{"name":"event","type":{"type":"record","name":"Event","fields":[{"name":"replayId","type":"long"}]}}]}},{"name":"channel","type":"string"}]}