Notifications

Register External Notification

POST
/orgs/{organizationId}/notifications/external

Registers a notification that your own system already sent (e.g. an email to a customer) so staff can see it in Tillor. Tillor does not send anything. Idempotent on externalSource + externalReference: repeating the call returns the existing notification. Read registered notifications with GET /notifications?source=EXTERNAL. Requires the notifications:external:write permission.

Authorization

ApiKeyAuth
headerx-api-key<token>

API key for authentication

Path Parameters

organizationId*string

The ID or slug of the organization

Request Body

application/json
  1. body
externalSource*string

Namespace of the system that sent the notification, e.g. 'mailchimp'.

Match^[a-z0-9][a-z0-9._-]*$
Length1 <= length <= 64
externalReference*string

Your own id for this notification. Unique per externalSource; repeating a create with the same pair returns the existing notification.

Match^[A-Za-z0-9._:/-]+$
Length1 <= length <= 191
name*string

Short staff-facing label, e.g. 'Booking confirmation'. Searchable; no personal data.

Length1 <= length <= 120
customerId?string
Length1 <= length
invoiceId?string
Length1 <= length
channel*unknown
email*
status*string
Value in"SENT""FAILED""BOUNCED""COMPLAINED"
sentAt?string
Formatdate-time
readAt?|null
clickedAt?|null
errorMessage?|null

Response Body

OK

application/json
  1. response
curl -X POST 'https://api.tillor.eu/orgs/string/notifications/external' \  -H 'Content-Type: application/json' \  -d '{  "externalSource": "string",  "externalReference": "string",  "name": "string",  "channel": "EMAIL",  "email": {    "to": "user@example.com",    "subject": "string"  },  "status": "SENT"}'
null