Docs

Emailchef API Authentication

How to authenticate Emailchef API requests: one Bearer API key plus a connectionId. MindCloud handles Emailchef's custom auth scheme for you.

Every Emailchef API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Emailchef account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a Emailchef connection in Connections. Emailchef uses its own authentication scheme. You provide whatever it requires when you create the connection — MindCloud handles the provider-specific details for you.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Emailchef account that should run the action. MindCloud stores and refreshes the Emailchef credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling List Lists with an Emailchef connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/emailchef/actions/list-lists/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Emailchef account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Get your Emailchef Consumer Key and Consumer Secret

You need access to an Emailchef account so you can create an API key from the Emailchef settings area.

  1. Sign in to Emailchef

    Open the Emailchef app and sign in to the account you want to connect.

  2. Open the API Keys page

    From Emailchef, go to Settings > API Keys.

  3. Create a new API key

    Select +Create API Key, give the key a recognizable name, and generate it.

  4. Copy both credential values

    Copy the Consumer Key and Consumer Secret and paste them into this connection form.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.