POST
/
webhook
/
api_key
/
validate
Validate API Key
curl --request POST \
  --url https://webhook.cocoonmail.com/webhook/api_key/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "shopify",
  "data": {
    "shop_id": "shop_123",
    "shop_name": "My Store"
  }
}
'
{
  "success": true,
  "workspace_id": "xyz12345ab",
  "workspace_name": "workspace name"
}

​
Validate API Key

Use this endpoint to validate your API Key

​
Response fields

PropertyDescription
400Bad request
401Request authentication
403Too many bad requests. Temparory block
406Missing accept header. For example : Accept: application/json
429Too many requests/ Rate limit exceeded
500Internal server error
{
  "success": true,
  "workspace_id": "xyz12345ab",
  "workspace_name": "workspace name"
}

Authorizations

​
Authorization
string
header
required

Use your API key with the 'Bearer ' prefix

Body

application/json
​
type
string
required
Example:

"shopify"

​
data
object
required

Arbitrary key-value pairs representing custom data. Common attributes include shop_id and shop_name.

Response

For valid API Key.

​
success
boolean
​
workspace_id
string
Example:

"cae15020ee"

​
workspace_name
string
Example:

"Cocoonmail Internal"