1MSG
ReferenceInbox API

Сменить секрет подписи вебхука Inbox

POST
/api/v1/inbox/webhook/secret

Один раз возвращает новый секрет. Старый секрет сразу перестаёт подходить для проверки доставок. Если адрес не сохранён, вернёт 404.

Authorization

bearer
headerAuthorizationBearer <token>

Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.

Response Body

application/json
  1. response
url?|

HTTPS-адрес, на который приходят POST-доставки. null, если вебхук не сохранён.

secretPrefix?|

Первые 12 символов секрета подписи. Полный секрет здесь не возвращается.

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

Когда закончилась последняя попытка доставки.

Formatdate-time
lastDeliveryStatus?|

HTTP-статус последней доставки. null, если ответа на запрос не было.

lastDeliveryError?|

Короткий текст ошибки последней неудачной доставки.

events*array<>

Все события, которые может присылать этот вебхук. События сообщений и статусов доставки приходят на вебхук канала.

envelope*

Пример JSON-тела, которое 1MSG отправляет POST-запросом. data совпадает с events[].example для типа из тела.

secret?|

Полный секрет подписи. Есть только при создании вебхука или смене секрета. Сохраните его: дальше в ответах будет только secretPrefix.

created*boolean

true, если этот вызов создал вебхук. false, если он сменил адрес или секрет.

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}