explain_relay
Validate a Gemmein relay definition before gemmein sync: get the dashboard sentence the relay will show or the single refusal naming the field and fix.
Instructions
Call while WRITING or FIXING gemmein/relays/.json — before gemmein sync carries it to the cloud. A relay is one trigger (receiver: a provider's webhook; schedule: a clock; data_change: a record changing) and up to ten actions in Gemmein's own verbs (write_record, grant_access, revoke_access, grant_credits, email_person, call_url, fulfil_product, refund_product, grant_plan, revoke_plan) — Gemmein runs it: receives the event, maps the fields, authorises, carries out the action. Pass the definition JSON; the answer is the English sentence the dashboard shows ("When gocardless-paid receives an event where event_type is confirmed → grant Pro, email the person, call https://…") or the ONE refusal sentence the cloud would answer, naming the field and the fix. Offline and read-only: nothing is created. Two checks run only in the cloud and are stated in the answer (the API's own hosts; the address's resolved network at call time).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| definition | Yes | the relay definition — the contents of gemmein/relays/<name>.json ({ name, trigger, actions }) |