Allocate the identity + set the inbound webhook callback

Allocates the org's address on first call. Set callback_url (https) to receive email.received webhooks. Optionally set username to choose a friendly address (username@relay.openhelm.ai). Returns the webhook_secret used to HMAC-sign webhooks.

post/emails/identity

Request

  • Base URL: https://worker.openhelm.ai/v1
  • URL: https://worker.openhelm.ai/v1/emails/identity
  • Auth: HTTP bearer

Request body

callback_urlstring uri

https endpoint for email.received webhooks.

usernamestring

Friendly email handle, e.g. "pilot-hotel-group" (3–32, a–z/0–9/-, unique).

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.