Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

List processor events

Lists stored processor hints; defaults to held events.

Lists stored processor hints; defaults to held events.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/processor_events
  • Scope billing:processor_events:read
  • Effect read — nothing is written.
  • Collection processor_events
  • Query page_size, page_token, filter
  • Pagination the answer carries processor_events and, when there is more, next_page_token

#Request

FieldTypeWhat it is
parentstringEnvironment resource name. Required.
page_sizeint32Default 50, at most 1000.
page_tokenstringToken from the preceding page, bound to environment and filter.
filterstringOnly state = "held" (the default), pending, applied, or dismissed.

#Response

FieldTypeWhat it is
processor_eventsProcessorEvent[]Events ordered by received time and event id.
next_page_tokenstringEmpty on the last page.

#ProcessorEvent

FieldTypeWhat it is
namestringName; the final segment is Stripe's event id.
uidstringStable, server-derived id. Output only.
metaResourceMetaMetadata; meta.etag is required on recovery calls. Output only.
account_idstringStripe account id, never the customer's identity. Output only.
event_typestringStripe event type. Output only.
object_idstringStripe object id (not a payload). Output only.
statestringpending, held, applied or dismissed. Output only.
hold_reasonstringprocessor_permission_denied, attempts_exhausted, or empty. Output only.
attemptsint32Number of failed application attempts. Output only.
livemodeboolWhether the owning merchant is live. Read only when mode_known is true. Output only.
mode_knownboolFalse when the owning merchant cannot be resolved; never assumes test. Output only.
last_recoveryProcessorEventRecoveryLast audited recovery decision, if any. Full history is retained. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#ProcessorEventRecovery

FieldTypeWhat it is
receipt_idstringStable receipt identity, scoped to this event and revision. Output only.
actionstringretry or dismiss. Output only.
reasonstringoperator_retry, permissions_restored, or test_processor_observation. Output only.
principalstringThe verified caller's principal, never supplied by the caller. Output only.
create_timetimestampCommit's decision time. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/processor_events" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"