Skip to main content
Version: 1.0.0

tinyRelay

Setup​

For TinyRelay setup contact us and provide the following information

  • WebHook URL: This is your public API which must support POST requests. All the [Webhooks] responses will be send on this API.
  • IP Addresses: List of IP where from using which you'll hit our API, we need to whitelist them for security purposes. 1

Contact us at support@tinyemail.com

Once you provide us with the above information, we'll send you an API key which will need in order to use the [Send Email] API.

Sender Domain Setup​

  1. Sign the domains to be used as From Senders in API calls. To do this, add a CNAME with following settings:
    • HOST: tec1._domainkey.YOUR_DOMAIN
    • VALUE: tec1.dkim.tinyemail.com
  2. Share a list of senders to be used in our API, we will need to add their domains in our MTA server.

For detailed information on how to setup sender domain, visit Authenticate your sending domain using a Dkim/Dmarc Record

1 : If you need to whitelist our IPs when we hit your public API (webHook) please let us know and we will send you the list.

Authentication​

TinyEmail offers below authentication:

  • API Key - Your API keys carry many privileges, so be sure to keep them secure. Don't share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication​

Provide the api key as bearer token as follows. Pass the value as TOKEN {{api_key}}. Replace the {{api_key}} with your API key provided during onbaording.

Security Scheme Type:apiKey
Header parameter name:X-RELAY-ACCESS-TOKEN

License

Apache 2.0