The online Trailblazer Community becomes read-only Oct 30, 2026. Read More
Download OpenAPI specification:Download
Get a personalized view of the events that affect the Salesforce tenants that you're authorized to access. Events include incidents, maintenance, patch releases, and informational messages. You can also refresh your personal access token (PAT).
A tenant is a distinct data space that doesn't implicitly share data with other tenants, such as a Salesforce org, a Marketing Cloud Engagement business unit, or a Commerce Cloud realm. The API uses the same tenants that you see in Salesforce My Trust Center.
Every response is limited to the tenants that the PAT in the request is authorized to access.
To authenticate, send your PAT as a Bearer token in the Authorization
header: Authorization: Bearer <PAT>.
Replaces the PAT in the Authorization header with a new PAT. The
current PAT must be active. When the refresh succeeds, the current PAT
is revoked immediately, so store the returned secret before your next
request. Refresh isn't idempotent, and the old and new PATs don't
overlap.
To estimate when a PAT expires, decode the exp claim, in Unix
seconds, from the PAT's JWT payload locally. The payload contains only
exp. Don't verify the signature, because the signing key isn't
published. The server's expiry and revocation status are
authoritative.
By default, the new PAT is valid for 30 days. To request a shorter
lifetime, set expiresInDays. A PAT and all of its replacements stay
valid for no more than 365 days in total.
Optional lifetime for the replacement PAT.
| expiresInDays | integer [ 1 .. 30 ] Default: 30 Lifetime of the replacement PAT, in whole days. |
{- "expiresInDays": 7
}{- "tokenId": "9aa0b1c2-d3e4-4f56-a789-0123456789ab",
- "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3OTE0Mjg0MDB9.example-signature",
- "label": "prod-servicenow",
- "createdAt": "2026-09-08T03:00:00.000Z",
- "expiresAt": "2026-10-08T03:00:00.000Z"
}Returns a snapshot of ongoing and upcoming events across all tenants
that you're authorized to access. The ongoing and upcoming buckets
each group events by event type.
A patch release can appear more than once, because each copy
represents a separate tenant scope and lifecycle. Copies can appear in
both ongoing and upcoming when your affected tenants are at
different stages. Each copy's scope identifies its tenants. Incidents,
maintenance events, and informational messages appear once per eventId.
Don't de-duplicate the snapshot by eventId.
| locale | string Default: "en-US" BCP 47 locale for localized response fields. Unsupported or malformed
values fall back to |
{- "ongoing": {
- "patch": [ ],
- "incident": [
- {
- "eventId": "evt-incident-001",
- "eventType": "incident",
- "title": "API latency",
- "description": "Some requests are experiencing elevated latency.",
- "status": "active",
- "startTime": "2026-10-08T16:00:00.000Z",
- "endTime": null,
- "duration": "PT35M",
- "displayDuration": "35 minutes",
- "products": [
- "Salesforce Services"
], - "services": [
- "Core Service"
], - "data": {
- "additionalInformation": "Traffic has been shifted to healthy capacity.",
- "rcaLink": null,
- "rcaCreatedAt": null
}, - "createdAt": "2026-10-08T16:00:00.000Z",
- "scope": {
- "tenants": {
- "00D000000000001": { }
}
}
}
], - "maintenance": [ ],
- "informationalMessage": [ ]
}, - "upcoming": {
- "patch": [ ],
- "incident": [ ],
- "maintenance": [
- {
- "eventId": "evt-maintenance-001",
- "eventType": "maintenance",
- "title": "Scheduled database maintenance",
- "description": "Routine database maintenance is scheduled.",
- "status": "confirmed",
- "startTime": null,
- "endTime": null,
- "duration": null,
- "displayDuration": null,
- "products": [
- "Salesforce Services"
], - "services": [
- "Core Service"
], - "data": {
- "plannedStartTime": "2026-10-12T02:00:00.000Z",
- "plannedEndTime": "2026-10-12T04:00:00.000Z",
- "additionalInformation": null
}, - "createdAt": "2026-10-06T18:00:00.000Z",
- "scope": {
- "tenants": {
- "00D000000000001": { }
}
}
}
], - "informationalMessage": [ ]
}
}Searches for events that affect the specified tenants within a time
window. In the request body, specify a list of tenant IDs, an optional
eventTypes filter, an inclusive startTime, and an exclusive
endTime. The response is a flat list of events in a stable order for
cursor pagination.
Pagination. pageSize defaults to 100, with a maximum of 200. When
more results are available, the response includes an opaque
nextPageToken. To get the next page, resend the original request
unchanged with pageToken set to that value. Repeat until the response
doesn't include nextPageToken. If the matching results change between
requests, the API rejects the token with a 400 error. Restart from
the first page so that you don't skip or duplicate events.
Authorization. The API ignores tenant IDs that you aren't
authorized to access. If you aren't authorized to access any of the
requested tenants, the response is 200 { "events": [] }.
Results. Each result has the same shape as an event from
GET /events/{eventId}, without timeline, and with a scope that
identifies the affected tenants. An event that matches more than one
requested tenant can appear once per matched tenant. status,
startTime, endTime, and duration are calculated separately for
each match, so they can differ between results with the same
eventId. For example, an incident can be resolved for one tenant
and active for another. To show one result per event, group results
by eventId. To get the full timeline, call GET /events/{eventId}.
| locale | string Default: "en-US" BCP 47 locale for localized response fields. Unsupported or malformed
values fall back to |
Tenants, event types, and time window to search.
required | Array of objects (EventSearchScope) [ 1 .. 50 ] items Tenant scopes to search, from 1 to 50 per request. Duplicate tenants are removed. |
| eventTypes | Array of strings (EventType) non-empty unique Items Enum: "patch" "incident" "maintenance" "informationalMessage" Event types to include. To include all event types, omit this property. |
| startTime required | string <date-time> Inclusive start of the search window, as a full ISO 8601 timestamp
with a |
| endTime required | string <date-time> Exclusive end of the search window. Uses the same format as
|
| pageSize | integer [ 1 .. 200 ] Default: 100 Maximum number of events to return on this page. |
| pageToken | string <= 4096 characters Opaque continuation token from the preceding response. Keep |
{- "scopes": [
- {
- "type": "tenant",
- "id": "00Dxx0000006MMM"
}
], - "eventTypes": [
- "incident",
- "maintenance"
], - "startTime": "2026-06-01T00:00:00Z",
- "endTime": "2026-09-01T00:00:00Z",
- "pageSize": 100
}{- "events": [
- {
- "eventId": "evt-incident-001",
- "eventType": "incident",
- "title": "API latency",
- "description": "Some requests are experiencing elevated latency.",
- "status": "active",
- "startTime": "2026-10-08T16:00:00.000Z",
- "endTime": null,
- "duration": "PT35M",
- "displayDuration": "35 minutes",
- "products": [
- "Salesforce Services"
], - "services": [
- "Core Service"
], - "data": {
- "additionalInformation": "Traffic has been shifted to healthy capacity.",
- "rcaLink": null,
- "rcaCreatedAt": null
}, - "createdAt": "2026-10-08T16:00:00.000Z",
- "scope": {
- "tenants": {
- "00D000000000001": { }
}
}
}
], - "nextPageToken": "opaque-continuation-token"
}Returns the event identified by eventId, including its timeline. Each
timeline entry includes a scope that lists which of your tenants the
entry applies to.
| eventId required | string Example: teofrchxogq373q Unique event ID. |
| locale | string Default: "en-US" BCP 47 locale for localized response fields. Unsupported or malformed
values fall back to |
{- "eventId": "evt-incident-001",
- "eventType": "incident",
- "title": "API latency",
- "description": "Some requests are experiencing elevated latency.",
- "status": "resolved",
- "startTime": "2026-10-08T16:00:00.000Z",
- "endTime": "2026-10-08T17:15:00.000Z",
- "duration": "PT1H15M",
- "displayDuration": "1 hour 15 minutes",
- "products": [
- "Salesforce Services"
], - "services": [
- "Core Service"
], - "data": {
- "additionalInformation": "Traffic was shifted to healthy capacity.",
- "rcaCreatedAt": "2026-10-08T20:00:00.000Z"
}, - "timeline": [
- {
- "subEventId": "subevent-001",
- "subEventType": "incident_started",
- "message": "We are investigating elevated API latency.",
- "createdAt": "2026-10-08T16:00:00.000Z",
- "updatedAt": "2026-10-08T16:00:00.000Z",
- "scope": {
- "tenants": {
- "00D000000000001": { }
}
}
}, - {
- "subEventId": "subevent-002",
- "subEventType": "incident_resolved",
- "message": "API latency has returned to normal.",
- "createdAt": "2026-10-08T17:15:00.000Z",
- "updatedAt": "2026-10-08T17:15:00.000Z",
- "scope": {
- "tenants": {
- "00D000000000001": { }
}
}
}
], - "createdAt": "2026-10-08T16:00:00.000Z"
}Returns the tenants that the PAT in the request is authorized to
access. Results are sorted by tenant ID and cloud for cursor
pagination. To get every page, follow nextPageToken until the
response doesn't include it. Keep all other request parameters the
same between pages.
| locale | string Default: "en-US" BCP 47 locale for localized response fields. Unsupported or malformed
values fall back to |
| pageSize | integer [ 1 .. 200 ] Default: 100 Maximum number of records to return on this page. |
| pageToken | string <= 4096 characters Opaque continuation token from the preceding response. Keep all other request parameters the same as in the request that returned the token. |
{- "tenants": [
- {
- "id": "00D000000000001",
- "cloud": "core",
- "name": "Example Corporation",
- "environment": "Production",
- "myDomain": "example"
}, - {
- "id": "00D000000000002",
- "cloud": "core",
- "name": "Example Sandbox",
- "environment": "Sandbox",
- "myDomain": "example--test"
}
], - "nextPageToken": "opaque-continuation-token"
}Returns details for a tenant, plus events whose lifecycle overlaps the
365 days before or after the request time. Informational messages cover
the 365 days before the request time. Each embedded event includes
parent-level event details and a scope that contains the requested
tenant, but not timeline. To get an event's timeline, call
GET /events/{eventId}.
| tenantId required | string Example: 00D000000000062 Tenant ID, from the |
| locale | string Default: "en-US" BCP 47 locale for localized response fields. Unsupported or malformed
values fall back to |
{- "id": "00D000000000001",
- "cloud": "core",
- "name": "Example Corporation",
- "environment": "Production",
- "myDomain": "example",
- "region": "AMER",
- "version": "266.12",
- "maintenanceWindow": "Sunday 02:00-04:00 UTC",
- "location": {
- "city": "San Francisco",
- "stateName": "California",
- "stateCode": "CA",
- "countryName": "United States",
- "countryCode": "US"
}, - "events": [
- {
- "eventId": "evt-incident-001",
- "eventType": "incident",
- "title": "API latency",
- "description": "Some requests are experiencing elevated latency.",
- "status": "resolved",
- "startTime": "2026-10-08T16:00:00.000Z",
- "endTime": "2026-10-08T17:15:00.000Z",
- "duration": "PT1H15M",
- "displayDuration": "1 hour 15 minutes",
- "products": [
- "Salesforce Services"
], - "services": [
- "Core Service"
], - "data": {
- "additionalInformation": "Traffic was shifted to healthy capacity.",
- "rcaCreatedAt": "2026-10-08T20:00:00.000Z"
}, - "createdAt": "2026-10-08T16:00:00.000Z",
- "scope": {
- "tenants": {
- "00D000000000001": { }
}
}
}
]
}