Monitoring Event Relays Using SOQL Queries

To run the queries given in this section, you can use one of these methods.

• The Developer Console’s Query Editor. For more information about the Developer Console, see Developer Console and Developer Console Query Editor.
• The query REST API resource using a REST API tool, such as Postman. See Query in the REST API Developer Guide. For information on how to set up Postman and use the Salesforce API Collection, see Salesforce APIs for Postman in GitHub. In REST API, spaces in the query must be replaced with +. In Postman, you don’t replace spaces in queries because Postman handles them.

You can perform a REST call, a GET request, to this endpoint with the SOQL query appended. Because EventRelayFeedback is a Salesforce object, use the data REST API to query the object and not Tooling API. In Postman, navigate to REST > Query.

/services/data/v58.0/query/?q=<query>

For a description of EventRelayFeedback non-system fields, see EventRelayFeedback in the Object Reference for the Salesforce Platform.

To get all the fields of EventRelayFeedback, run this query.

SELECT FIELDS(ALL) FROM EventRelayFeedback LIMIT 200

Example of a REST query call.

/services/data/v58.0/query/?q=SELECT+FIELDS(ALL)+from+EventRelayFeedback+LIMIT+200

If you aren’t interested in the system fields returned, use this query, which specifies non-system fields in the SELECT clause.

SELECT EventRelayNumber, EventRelayConfigId, LastRelayedEventTime, RemoteResource, Status,
    ErrorCode, ErrorMessage, ErrorTime, ErrorIdentifier FROM EventRelayFeedback

Example query response received using the REST query resource.

{
    "totalSize": 1,
    "done": true,
    "records": [
        {
            "attributes": {
                "type": "EventRelayFeedback",
                "url": "/services/data/v58.0/sobjects/EventRelayFeedback/7k4RM0000004LjjYAE"
            },
            "EventRelayNumber": "00000004",
            "EventRelayConfigId": "7k2RM0000004LoAYAU",
            "LastRelayedEventTime": "2023-04-03T19:23:23.000+0000",
            "RemoteResource": "aws.partner/salesforce.com/00DRM000000G2tq2AC/0YLRM00000001es4AA",
            "Status": "RUNNING",
            "ErrorCode": null,
            "ErrorMessage": null,
            "ErrorTime": null,
            "ErrorIdentifier": null
        }
    ]
}

The fields returned in the query correspond to fields in the UI. For example, RemoteResource corresponds to the Partner Event Source Name field, and LastRelayedEventTime corresponds to the Last Relayed field in the event relay detail page. For more information, see Event Relays in Setup.