Skip to main content
POST
/
connections
/
preview-event
Preview event dispatch envelopes
curl --request POST \
  --url https://api.example.com/connections/preview-event \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "item_id": "<string>",
  "connection_id": "<string>",
  "cycle": {
    "originating_connection_id": "<string>",
    "hop_count": 1
  }
}
'
{
  "envelopes": [
    {
      "connection_id": "<string>",
      "integration_name": "<string>",
      "would_dispatch": true,
      "envelope": {
        "integration_name": "<string>",
        "connection_id": "<string>",
        "event_type": "<string>",
        "item_id": "<string>",
        "cycle": {
          "originating_connection_id": "<string>",
          "hop_count": 1
        },
        "tenant_id": "<string>",
        "payload": null
      }
    }
  ],
  "hop_budget": {
    "max": 1,
    "used": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.myme.so/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Pass an API key (marfa_k1_...) or OAuth access token (marfa_at_...)

Body

application/json
item_id
string
required
Minimum string length: 1
event_type
enum<string>
required
Available options:
created,
updated,
deleted,
restored,
state_changed,
metadata_changed
connection_id
string
cycle
object

Response

One entry per subscriber the operator asked about, plus the tenant's hop budget.

envelopes
object[]
required
hop_budget
object
required