API reference › Handshakes

Message the provider

POST /v1/handshakes/{id}/notify

Scope
handshakes:edit
Roles
admin, scheduler

Sends an in-app notification and optionally a custom email. Supply message, or both emailSubject and emailMessage — the email pair must be sent together.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Handshake ID.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

FieldTypeDescription
messagestring or null

In-app message. Required unless an email subject and body are supplied.

max length 2000. Example Request processed successfully..

emailSubjectstring or null

Required when emailMessage is present.

max length 255.

emailMessagestring or null

Required when emailSubject is present.

max length 5000. Example Request processed successfully..

Example

JSON
{
  "message": "Request processed successfully.",
  "emailSubject": "string",
  "emailMessage": "Request processed successfully."
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/handshakes/{id}/notify" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"message":"Request processed successfully.","emailSubject":"string","emailMessage":"Request processed successfully."}'

Try it

Responses

200 Notification sent successfully

Notification sent successfully.

JSON
{
  "success": true,
  "message": "Notification sent successfully."
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Notification sent successfully..

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'handshakes:edit' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'handshakes:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation failed.

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Unable to save. Please check the highlighted fields.

errorsany or null

Details when the handler has them — a field-keyed object, a single string, or null.

codestring

Empty unless the handler sets one.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.