Enviar push - Notifique

curl --request POST \
  --url https://api.notifique.dev/v1/push/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": [
    "clxxdevice1..."
  ],
  "type": "push",
  "payload": {
    "title": "Olá!",
    "body": "Você tem uma nova mensagem.",
    "url": "https://seusite.com/notificacoes",
    "icon": "https://seusite.com/icon.png"
  },
  "options": {
    "priority": "high",
    "webhook": {
      "url": "https://api.seudominio.com/hooks/push-events"
    }
  },
  "metadata": {
    "deeplink": "order/99"
  }
}
'

{
  "success": true,
  "data": {
    "count": 123,
    "messageIds": [
      "<string>"
    ],
    "pushIds": [
      "<string>"
    ],
    "scheduledAt": "2023-11-07T05:31:56Z"
  }
}

{
  "success": true,
  "data": {
    "status": "QUEUED",
    "count": 2,
    "messageIds": [
      "clxxpush1...",
      "clxxpush2..."
    ],
    "pushIds": [
      "clxxpush1...",
      "clxxpush2..."
    ]
  }
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

POST

push

messages

curl --request POST \
  --url https://api.notifique.dev/v1/push/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": [
    "clxxdevice1..."
  ],
  "type": "push",
  "payload": {
    "title": "Olá!",
    "body": "Você tem uma nova mensagem.",
    "url": "https://seusite.com/notificacoes",
    "icon": "https://seusite.com/icon.png"
  },
  "options": {
    "priority": "high",
    "webhook": {
      "url": "https://api.seudominio.com/hooks/push-events"
    }
  },
  "metadata": {
    "deeplink": "order/99"
  }
}
'

{
  "success": true,
  "data": {
    "count": 123,
    "messageIds": [
      "<string>"
    ],
    "pushIds": [
      "<string>"
    ],
    "scheduledAt": "2023-11-07T05:31:56Z"
  }
}

{
  "success": true,
  "data": {
    "status": "QUEUED",
    "count": 2,
    "messageIds": [
      "clxxpush1...",
      "clxxpush2..."
    ],
    "pushIds": [
      "clxxpush1...",
      "clxxpush2..."
    ]
  }
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

Autorizações

Authorization

string

header

obrigatório

Authorization: Bearer sk_live_xxxxx

Cabeçalhos

Idempotency-Key

string

Chave única para evitar envio duplicado.

x-idempotency-key

string

Corpo

application/json

string[]

obrigatório

IDs de dispositivos push registrados (1–100 por chamada).

Required array length: 1 - 100 elements

type

enum<string>

obrigatório

Tipo: push (conteúdo em payload) ou template (template do workspace em payload.templateId).

Opções disponíveis:

push,

template

payload

object

obrigatório

Conteúdo conforme type. push: pelo menos title ou body; opcionais url, icon, image, data. template: templateId (obrigatório) e variables opcionais.

schedule

object

Show child attributes

options

object

Show child attributes

metadata

object

Metadados em PushLog.metadata (string→string).

Show child attributes

Resposta

Resposta em cache (idempotency): mesma resposta do 202 da primeira chamada.

success

boolean

obrigatório

Exemplo:

true

data

object

obrigatório

Show child attributes

Remover dispositivo push Listar mensagens push