Задать адрес вебхука Inbox аккаунта
Создаёт вебхук и один раз возвращает секрет подписи или меняет адрес, оставляя прежний секрет.
bearerAuthorizationBearer <token>Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.
application/json- body
url*stringHTTPS-адрес. 1MSG отправляет сюда POST с событием в JSON. Адреса с логином и паролем внутри отклоняются.
application/json- response
url?|HTTPS-адрес, на который приходят POST-доставки. null, если вебхук не сохранён.
secretPrefix?|Первые 12 символов секрета подписи. Полный секрет здесь не возвращается.
createdAt?|date-timeupdatedAt?|date-timelastDeliveryAt?|Когда закончилась последняя попытка доставки.
date-timelastDeliveryStatus?|HTTP-статус последней доставки. null, если ответа на запрос не было.
lastDeliveryError?|Короткий текст ошибки последней неудачной доставки.
events*array<>Все события, которые может присылать этот вебхук. События сообщений и статусов доставки приходят на вебхук канала.
envelope*Пример JSON-тела, которое 1MSG отправляет POST-запросом. data совпадает с events[].example для типа из тела.
secret?|Полный секрет подписи. Есть только при создании вебхука или смене секрета. Сохраните его: дальше в ответах будет только secretPrefix.
created*booleantrue, если этот вызов создал вебхук. false, если он сменил адрес или секрет.
curl -X PUT 'https://api.1msg.io/api/v1/inbox/webhook' \ -H 'Content-Type: application/json' \ -d '{ "url": "https://example.com/1msg/inbox"}'{ "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}