Send Notify External

Use this endpoint to send notification messages externally to members.

📘 Request URL

POST https://openapi.zwiz.app/zignal/api/external/notify

📥 Request Headers

Name	Type	Required	Description
X-System-Id	String	✅	System ID you received from Home menu
X-Api-Key	String	✅	HMAC-SHA256 token from Create Authentication Token
Content-Type	String	✅	application/json

📥 Request Body

Name	Type	Required	Description
receive_member_ids	Array of String	✅	Member IDs to send notifications to (get from Get Business Members)
sender_id	String	✅	ID of the sender
sender_name	String	❌	Display name of the sender
sender_picture_url	String	❌	Image URL of the sender
notify_content	Array of Object	✅	List of content blocks to notify (text or image)
created_by	String	✅	Creator identifier

📘 notify_content Object

Name	Type	Required	Description
type	String	✅	Content type: text or image
text	String	When type is text	Text to display
url	String	When type is image	Image URL

💡 Request Example

curl --location 'https://openapi.zwiz.app/zignal/api/external/notify' \
--header 'X-System-Id: {example-system-id}' \
--header 'X-Api-Key: {generated-x-api-key}' \
--header 'Content-Type: application/json' \
--data '{
  "receive_member_ids": ["example-member-id"],
  "sender_id": "xxx",
  "sender_name": "xxx",
  "sender_picture_url": "xxx",
  "notify_content": [
    {
      "type": "text",
      "text": "test"
    },
    {
      "type": "image",
      "url": "https://Example.png"
    }
  ],
  "created_by": "xxx"
}'

📤 Response

{
  "status": "success",
  "message": "Notification sent successfully"
}