1MSG
ReferenceInbox API

Trocar o segredo de assinatura do webhook do Inbox

POST
/api/v1/inbox/webhook/secret

Retorna o novo segredo uma única vez. O segredo anterior deixa de validar entregas na hora. Retorna 404 quando não há URL salva.

Authorization

bearer
headerAuthorizationBearer <token>

Chave gerada em Settings → Developer → API key. Os métodos do Inbox precisam do escopo Inbox. Os métodos de Campaigns precisam do escopo Campaigns.

Response Body

application/json
  1. response
url?|

URL HTTPS que recebe as entregas por POST. null quando não há webhook salvo.

secretPrefix?|

Os primeiros 12 caracteres do segredo de assinatura. O segredo completo não é retornado aqui.

createdAt?|
Formatdate-time
updatedAt?|
Formatdate-time
lastDeliveryAt?|

Quando terminou a última tentativa de entrega.

Formatdate-time
lastDeliveryStatus?|

Status HTTP da última entrega. null quando a requisição não teve resposta.

lastDeliveryError?|

Erro resumido da última entrega que falhou.

events*array<>

Todos os eventos que este webhook pode enviar. Eventos de mensagem e de status de entrega continuam no webhook do canal.

envelope*

Exemplo do corpo JSON que a 1MSG envia por POST. data corresponde a events[].example para o type do corpo.

secret?|

Segredo de assinatura completo. Aparece só quando o webhook é criado ou o segredo é trocado. Guarde-o: as leituras seguintes retornam só secretPrefix.

created*boolean

true quando esta chamada criou o webhook. false quando atualizou a URL ou trocou o segredo.

curl -X POST 'https://api.1msg.io/api/v1/inbox/webhook/secret'
{  "url": "https://example.com/1msg/inbox",  "secretPrefix": "whsec_abc123",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "lastDeliveryAt": "2019-08-24T14:15:22Z",  "lastDeliveryStatus": 200,  "lastDeliveryError": "string",  "events": [    {      "type": "inbox.conversation.status_changed",      "description": "Conversation opened or closed. status is OPEN or CLOSED.",      "example": {        "conversationId": "d94a047f-5984-42af-9f89-0f26c7e70ef1",        "channelId": "QAF261225002",        "status": "CLOSED",        "previousStatus": "OPEN",        "actorUserId": "b2bb82f0-2253-4e05-b955-a21f3d699caa"      }    }  ],  "envelope": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "type": "inbox.conversation.status_changed",    "createdAt": "2019-08-24T14:15:22Z",    "data": {}  },  "secret": "whsec_example_secret",  "created": true}