Skip to content

Account

GET /client

Returns your account, the mode of the key you used, and your webhook URL.

{
"id": "3f2c9a1e-5b7d-4c8e-9f10-2a3b4c5d6e7f",
"name": "Your business",
"mode": "LIVE",
"webhookUrl": "https://api.example.com/tujyane/webhooks"
}
Field Type Notes
id UUID Your account id
name string
mode TEST | LIVE The mode of the key you used
webhookUrl string | null Where Tujyane sends events. Tujyane sets it.

POST /webhooks/test

Sends a signed ping event to your webhook URL at once, and tells you what your receiver answered. The ping has type: "ping" and data: {}. Tujyane does not store or retry it.

{ "delivered": true, "statusCode": 200, "error": null }
Field Type Notes
delivered boolean true when your receiver answered 2xx within 10 seconds
statusCode integer | null Your receiver’s status, or null if it did not answer
error string | null Why the delivery failed, for example a timeout

Errors: 409 NO_WEBHOOK_URL when no webhook URL is set.