Mediflo
REST APIVocabularies

List webhook event types and payload blocks

Any valid API key may read this — it is contract metadata, not tenant data. The event list depends on the features enabled for your organisation: event families of areas it has not enabled (e.g. `case.*`) are left out, so do not cache the response across organisations. `phiBlocks` marks the blocks that carry personal data, including sensitive data. Required scope: `(any valid key)`.

GET/meta/event-types

Authorization

ApiKeyAuth
AuthorizationBearer <token>

An external API key, sent as Authorization: Bearer mflo_…. Scopes are checked per route; see each operation’s description.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/meta/event-types"
{  "data": {    "eventTypes": [      {        "type": "ping",        "family": "string",        "description": "string",        "availableBlocks": [          "phoneNumbers"        ],        "phiBlocks": [          "phoneNumbers"        ],        "sampleEnvelope": {          "id": "string",          "type": "ping",          "apiVersion": "string",          "occurredAt": "string",          "data": null        }      }    ],    "payloadBlocks": [      "phoneNumbers"    ],    "phiBlocks": [      "string"    ]  }}