Create a notification

curl --request POST \
  --url https://api.assembly.com/v1/notifications \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "deliveryTargets": {},
  "senderId": "550e8400-e29b-41d4-a716-446655440000",
  "notificationSettingId": "550e8400-e29b-41d4-a716-446655440006",
  "recipientClientId": "550e8400-e29b-41d4-a716-446655440001",
  "recipientCompanyId": "550e8400-e29b-41d4-a716-446655440003",
  "recipientId": "550e8400-e29b-41d4-a716-446655440001",
  "recipientInternalUserId": "550e8400-e29b-41d4-a716-446655440004",
  "recipientType": "client",
  "senderCompanyId": "550e8400-e29b-41d4-a716-446655440003"
}
'

import requests

url = "https://api.assembly.com/v1/notifications"

payload = {
    "deliveryTargets": {},
    "senderId": "550e8400-e29b-41d4-a716-446655440000",
    "notificationSettingId": "550e8400-e29b-41d4-a716-446655440006",
    "recipientClientId": "550e8400-e29b-41d4-a716-446655440001",
    "recipientCompanyId": "550e8400-e29b-41d4-a716-446655440003",
    "recipientId": "550e8400-e29b-41d4-a716-446655440001",
    "recipientInternalUserId": "550e8400-e29b-41d4-a716-446655440004",
    "recipientType": "client",
    "senderCompanyId": "550e8400-e29b-41d4-a716-446655440003"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deliveryTargets: {},
    senderId: '550e8400-e29b-41d4-a716-446655440000',
    notificationSettingId: '550e8400-e29b-41d4-a716-446655440006',
    recipientClientId: '550e8400-e29b-41d4-a716-446655440001',
    recipientCompanyId: '550e8400-e29b-41d4-a716-446655440003',
    recipientId: '550e8400-e29b-41d4-a716-446655440001',
    recipientInternalUserId: '550e8400-e29b-41d4-a716-446655440004',
    recipientType: 'client',
    senderCompanyId: '550e8400-e29b-41d4-a716-446655440003'
  })
};

fetch('https://api.assembly.com/v1/notifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.assembly.com/v1/notifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'deliveryTargets' => [
        
    ],
    'senderId' => '550e8400-e29b-41d4-a716-446655440000',
    'notificationSettingId' => '550e8400-e29b-41d4-a716-446655440006',
    'recipientClientId' => '550e8400-e29b-41d4-a716-446655440001',
    'recipientCompanyId' => '550e8400-e29b-41d4-a716-446655440003',
    'recipientId' => '550e8400-e29b-41d4-a716-446655440001',
    'recipientInternalUserId' => '550e8400-e29b-41d4-a716-446655440004',
    'recipientType' => 'client',
    'senderCompanyId' => '550e8400-e29b-41d4-a716-446655440003'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.assembly.com/v1/notifications"

	payload := strings.NewReader("{\n  \"deliveryTargets\": {},\n  \"senderId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"notificationSettingId\": \"550e8400-e29b-41d4-a716-446655440006\",\n  \"recipientClientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\",\n  \"recipientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientInternalUserId\": \"550e8400-e29b-41d4-a716-446655440004\",\n  \"recipientType\": \"client\",\n  \"senderCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.assembly.com/v1/notifications")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deliveryTargets\": {},\n  \"senderId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"notificationSettingId\": \"550e8400-e29b-41d4-a716-446655440006\",\n  \"recipientClientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\",\n  \"recipientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientInternalUserId\": \"550e8400-e29b-41d4-a716-446655440004\",\n  \"recipientType\": \"client\",\n  \"senderCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.assembly.com/v1/notifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deliveryTargets\": {},\n  \"senderId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"notificationSettingId\": \"550e8400-e29b-41d4-a716-446655440006\",\n  \"recipientClientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\",\n  \"recipientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientInternalUserId\": \"550e8400-e29b-41d4-a716-446655440004\",\n  \"recipientType\": \"client\",\n  \"senderCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\"\n}"

response = http.request(request)
puts response.read_body

{
  "additionalFields": {
    "channelName": "<string>",
    "invoiceNumber": "<string>",
    "senderName": "<string>"
  },
  "appId": "550e8400-e29b-41d4-a716-446655440005",
  "assetS3Key": "<string>",
  "channelId": "<string>",
  "companyId": "550e8400-e29b-41d4-a716-446655440003",
  "count": 123,
  "createdAt": "<string>",
  "creatorId": "<string>",
  "data": "<string>",
  "defaultListIndexPkey": "<string>",
  "deliveryTargets": {
    "email": {
      "header": "You have a new file",
      "subject": "New file uploaded",
      "title": "New file uploaded",
      "body": "A new file was uploaded to your portal.",
      "ctaParams": {},
      "htmlBody": "<p>A new file was uploaded to your portal.</p>"
    },
    "inProduct": {
      "title": "New file uploaded",
      "body": "A new file was uploaded to your portal.",
      "ctaParams": {},
      "isRead": false
    }
  },
  "event": "file.created",
  "fields": {
    "channelId": "<string>",
    "companyId": "<string>",
    "count": 123,
    "formId": "<string>",
    "groupingEntityType": "<string>",
    "itemName": "<string>",
    "notificationGroup": "<string>",
    "senderID": "<string>",
    "senderType": "<string>",
    "senderUserId": "<string>"
  },
  "id": "<string>",
  "identityId": "<string>",
  "isGroup": true,
  "isRead": true,
  "object": "<string>",
  "previousAttributes": {},
  "recipientClientId": "550e8400-e29b-41d4-a716-446655440001",
  "recipientCompanyId": "550e8400-e29b-41d4-a716-446655440003",
  "recipientId": "550e8400-e29b-41d4-a716-446655440001",
  "recipientInternalUserId": "550e8400-e29b-41d4-a716-446655440004",
  "ref": "<string>",
  "reminders": {
    "scheduled": [
      "<string>"
    ],
    "sent": [
      "<string>"
    ]
  },
  "resourceId": "550e8400-e29b-41d4-a716-446655440002",
  "senderCompanyId": "550e8400-e29b-41d4-a716-446655440003",
  "senderId": "550e8400-e29b-41d4-a716-446655440000",
  "senderType": "internalUser",
  "updatedAt": "<string>"
}

{
  "message": "notification suppressed by recipient notification settings"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

POST

notifications

Create a notification

curl --request POST \
  --url https://api.assembly.com/v1/notifications \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "deliveryTargets": {},
  "senderId": "550e8400-e29b-41d4-a716-446655440000",
  "notificationSettingId": "550e8400-e29b-41d4-a716-446655440006",
  "recipientClientId": "550e8400-e29b-41d4-a716-446655440001",
  "recipientCompanyId": "550e8400-e29b-41d4-a716-446655440003",
  "recipientId": "550e8400-e29b-41d4-a716-446655440001",
  "recipientInternalUserId": "550e8400-e29b-41d4-a716-446655440004",
  "recipientType": "client",
  "senderCompanyId": "550e8400-e29b-41d4-a716-446655440003"
}
'

import requests

url = "https://api.assembly.com/v1/notifications"

payload = {
    "deliveryTargets": {},
    "senderId": "550e8400-e29b-41d4-a716-446655440000",
    "notificationSettingId": "550e8400-e29b-41d4-a716-446655440006",
    "recipientClientId": "550e8400-e29b-41d4-a716-446655440001",
    "recipientCompanyId": "550e8400-e29b-41d4-a716-446655440003",
    "recipientId": "550e8400-e29b-41d4-a716-446655440001",
    "recipientInternalUserId": "550e8400-e29b-41d4-a716-446655440004",
    "recipientType": "client",
    "senderCompanyId": "550e8400-e29b-41d4-a716-446655440003"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deliveryTargets: {},
    senderId: '550e8400-e29b-41d4-a716-446655440000',
    notificationSettingId: '550e8400-e29b-41d4-a716-446655440006',
    recipientClientId: '550e8400-e29b-41d4-a716-446655440001',
    recipientCompanyId: '550e8400-e29b-41d4-a716-446655440003',
    recipientId: '550e8400-e29b-41d4-a716-446655440001',
    recipientInternalUserId: '550e8400-e29b-41d4-a716-446655440004',
    recipientType: 'client',
    senderCompanyId: '550e8400-e29b-41d4-a716-446655440003'
  })
};

fetch('https://api.assembly.com/v1/notifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.assembly.com/v1/notifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'deliveryTargets' => [
        
    ],
    'senderId' => '550e8400-e29b-41d4-a716-446655440000',
    'notificationSettingId' => '550e8400-e29b-41d4-a716-446655440006',
    'recipientClientId' => '550e8400-e29b-41d4-a716-446655440001',
    'recipientCompanyId' => '550e8400-e29b-41d4-a716-446655440003',
    'recipientId' => '550e8400-e29b-41d4-a716-446655440001',
    'recipientInternalUserId' => '550e8400-e29b-41d4-a716-446655440004',
    'recipientType' => 'client',
    'senderCompanyId' => '550e8400-e29b-41d4-a716-446655440003'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.assembly.com/v1/notifications"

	payload := strings.NewReader("{\n  \"deliveryTargets\": {},\n  \"senderId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"notificationSettingId\": \"550e8400-e29b-41d4-a716-446655440006\",\n  \"recipientClientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\",\n  \"recipientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientInternalUserId\": \"550e8400-e29b-41d4-a716-446655440004\",\n  \"recipientType\": \"client\",\n  \"senderCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.assembly.com/v1/notifications")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deliveryTargets\": {},\n  \"senderId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"notificationSettingId\": \"550e8400-e29b-41d4-a716-446655440006\",\n  \"recipientClientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\",\n  \"recipientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientInternalUserId\": \"550e8400-e29b-41d4-a716-446655440004\",\n  \"recipientType\": \"client\",\n  \"senderCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.assembly.com/v1/notifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deliveryTargets\": {},\n  \"senderId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"notificationSettingId\": \"550e8400-e29b-41d4-a716-446655440006\",\n  \"recipientClientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\",\n  \"recipientId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"recipientInternalUserId\": \"550e8400-e29b-41d4-a716-446655440004\",\n  \"recipientType\": \"client\",\n  \"senderCompanyId\": \"550e8400-e29b-41d4-a716-446655440003\"\n}"

response = http.request(request)
puts response.read_body

{
  "additionalFields": {
    "channelName": "<string>",
    "invoiceNumber": "<string>",
    "senderName": "<string>"
  },
  "appId": "550e8400-e29b-41d4-a716-446655440005",
  "assetS3Key": "<string>",
  "channelId": "<string>",
  "companyId": "550e8400-e29b-41d4-a716-446655440003",
  "count": 123,
  "createdAt": "<string>",
  "creatorId": "<string>",
  "data": "<string>",
  "defaultListIndexPkey": "<string>",
  "deliveryTargets": {
    "email": {
      "header": "You have a new file",
      "subject": "New file uploaded",
      "title": "New file uploaded",
      "body": "A new file was uploaded to your portal.",
      "ctaParams": {},
      "htmlBody": "<p>A new file was uploaded to your portal.</p>"
    },
    "inProduct": {
      "title": "New file uploaded",
      "body": "A new file was uploaded to your portal.",
      "ctaParams": {},
      "isRead": false
    }
  },
  "event": "file.created",
  "fields": {
    "channelId": "<string>",
    "companyId": "<string>",
    "count": 123,
    "formId": "<string>",
    "groupingEntityType": "<string>",
    "itemName": "<string>",
    "notificationGroup": "<string>",
    "senderID": "<string>",
    "senderType": "<string>",
    "senderUserId": "<string>"
  },
  "id": "<string>",
  "identityId": "<string>",
  "isGroup": true,
  "isRead": true,
  "object": "<string>",
  "previousAttributes": {},
  "recipientClientId": "550e8400-e29b-41d4-a716-446655440001",
  "recipientCompanyId": "550e8400-e29b-41d4-a716-446655440003",
  "recipientId": "550e8400-e29b-41d4-a716-446655440001",
  "recipientInternalUserId": "550e8400-e29b-41d4-a716-446655440004",
  "ref": "<string>",
  "reminders": {
    "scheduled": [
      "<string>"
    ],
    "sent": [
      "<string>"
    ]
  },
  "resourceId": "550e8400-e29b-41d4-a716-446655440002",
  "senderCompanyId": "550e8400-e29b-41d4-a716-446655440003",
  "senderId": "550e8400-e29b-41d4-a716-446655440000",
  "senderType": "internalUser",
  "updatedAt": "<string>"
}

{
  "message": "notification suppressed by recipient notification settings"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

Notification to create

deliveryTargets

object

required

DeliveryTargets describes how the notification should be delivered. Required.

Show child attributes

senderId

string<uuid>

required

SenderID is the member triggering the notification. Required.

Example:

"550e8400-e29b-41d4-a716-446655440000"

notificationSettingId

string

NotificationSettingId optionally selects one of the app's declared notification settings (see the app's notificationConfig). When provided, delivery on each surface is resolved against the recipient's per-setting preference, falling back to the app's configured default. Optional; when omitted, all requested delivery targets are delivered as-is.

Example:

"550e8400-e29b-41d4-a716-446655440006"

recipientClientId

string<uuid>

RecipientClientID is the client to notify. Pair with recipientCompanyId.

Example:

"550e8400-e29b-41d4-a716-446655440001"

recipientCompanyId

string<uuid>

RecipientCompanyID is the company of the client being notified.

Example:

"550e8400-e29b-41d4-a716-446655440003"

recipientId

string<uuid>

deprecated

RecipientID is the recipient to notify. Deprecated: prefer recipientClientId+ recipientCompanyId or recipientInternalUserId, which take precedence when provided.

Example:

"550e8400-e29b-41d4-a716-446655440001"

recipientInternalUserId

string<uuid>

RecipientInternalUserID is the internal user to notify.

Example:

"550e8400-e29b-41d4-a716-446655440004"

recipientType

enum<string>

RecipientType is the kind of member being notified.

Example:

"client"

senderCompanyId

string<uuid>

SenderCompanyID is the sender's company, required when notifying an internal user.

Example:

"550e8400-e29b-41d4-a716-446655440003"

Response

additionalFields

object

Show child attributes

appId

string<uuid>

AppID is the ID of the custom app that created the notification, when applicable.

Example:

"550e8400-e29b-41d4-a716-446655440005"

assetS3Key

string

channelId

string

companyId

string<uuid>

CompanyID is the company the notification is associated with, when applicable.

Example:

"550e8400-e29b-41d4-a716-446655440003"

count

integer

createdAt

string

creatorId

string

data

string

defaultListIndexPkey

string

DefaultListIndexPkey for the notification model is used to mark whether a notification is an inbox notification

deliveryTargets

object

DeliveryTargets describes how the notification is delivered (in-product and/or email).

Show child attributes

event

enum<string>

Event is the domain event that triggered the notification.

Available options:

files.created,

file.created,

contract.signed,

contract.requested,

formResponse.requested,

formResponse.completed,

form.created,

invoice.paid,

invoice.requested,

invoice.processing,

invoice.paymentFailed,

refund.requested,

refund.processed,

refund.failed,

autoChargePayment.requested,

customApp.action,

internalChat.mentioned,

channel.mentioned

Example:

"file.created"

fields

object

todo: remove fields once FE doesn't use them

Show child attributes

string

identityId

string

isGroup

boolean

isRead

boolean

Deprecated: use DeliveryTargets.InProduct.IsRead

object

string

previousAttributes

object

recipientClientId

string<uuid>

RecipientClientID is the recipient client ID, set when the recipient is a client.

Example:

"550e8400-e29b-41d4-a716-446655440001"

recipientCompanyId

string<uuid>

RecipientCompanyID is the recipient company ID, set when the recipient is a client (their company).

Example:

"550e8400-e29b-41d4-a716-446655440003"

recipientId

string<uuid>

RecipientID is the ID of the member the notification is delivered to.

Example:

"550e8400-e29b-41d4-a716-446655440001"

recipientInternalUserId

string<uuid>

RecipientInternalUserID is the recipient internal user ID, set when the recipient is an internal user.

Example:

"550e8400-e29b-41d4-a716-446655440004"

recipientType

enum<string>

Available options:

USER,

CLIENT_USER,

CLIENT_COMPANY

ref

string

reminders

object

Show child attributes

resourceId

string

ResourceID is the ID of the resource the notification refers to (e.g. the uploaded file or invoice).

Example:

"550e8400-e29b-41d4-a716-446655440002"

senderCompanyId

string<uuid>

SenderCompanyID is the sender's company ID, set when the recipient is an internal user.

Example:

"550e8400-e29b-41d4-a716-446655440003"

senderId

string<uuid>

SenderID is the ID of the member who triggered the notification.

Example:

"550e8400-e29b-41d4-a716-446655440000"

senderType

enum<string>

SenderType is the kind of member that sent the notification.

Example:

"internalUser"

updatedAt

string

List notifications Retrieve a notification

⌘I

Getting started

Webhooks

Core Resources

CRM

Messaging

Billing

Files

Contracts

Forms

Tasks

Token

Others

Create a notification

Authorizations

Body

Response