Подпись HMAC-SHA256
Каждая доставка несёт подпись, вычисленную по телу запроса и секрету вашего эндпоинта, поэтому получатель может убедиться, что запрос действительно пришёл от нас, прежде чем что-то делать.
Исходящие вебхуки
Тридцать одно событие, от создания контакта до сорванного срока ответа в поддержке или отклонённого объявления, приходит на ваш эндпоинт подписанными HTTP POST-запросами с автоматическими повторами. На тарифе Business. Никакого цикла опроса и никакого cron-задания, которое спрашивает, не изменилось ли что-нибудь.
Последнее обновление:
Подписывайте эндпоинт только на нужные ему события, а не получайте всё подряд с фильтрацией на своей стороне.
Отправить POST с JSON может кто угодно. А пригодными для продакшена вебхуки делают подпись, повторы при сбоях и возможность увидеть, что произошло.
Каждая доставка несёт подпись, вычисленную по телу запроса и секрету вашего эндпоинта, поэтому получатель может убедиться, что запрос действительно пришёл от нас, прежде чем что-то делать.
Неудачная доставка повторяется с нарастающей задержкой, а не отбрасывается, поэтому окно деплоя или короткий сбой на вашей стороне не съедят молча то самое важное событие.
Видно, что было отправлено, когда, что ответил ваш эндпоинт и сколько это заняло. Отладка интеграции перестаёт быть спором о том, сработало ли событие.
Каждый эндпоинт подписывается на нужные ему события. Сервису исполнения заказов, которому важен только invoice.paid, не придётся получать и выбрасывать каждое обновление контакта.
До двадцати эндпоинтов, так что складская система, внутренний ретранслятор в Slack и хранилище данных могут получать свой поток со своим секретом.
Тестовое событие позволяет проверить эндпоинт, сверку подписи и ваш обработчик до того, как от работы всех трёх будет зависеть настоящий deal.won.
support.ticket.breached срабатывает, когда сорван обещанный срок ответа. Именно это событие большинство команд хотят видеть в канале дежурных, а не на дашборде, который никто не открывает.
События отправляют контакты, этапы воронки, сообщения, шаги и ответы в цепочках привлечения, сделки, задачи, счета, транзакции, подписки, тикеты поддержки и оповещения рекламных аккаунтов.
Вебхук сообщает, что что-то произошло; публичный REST API позволяет прочитать или изменить запись, с которой это произошло. Вместе они полностью заменяют опрос.
Вебхук — это HTTP POST, который Pinlyx отправляет на ваш URL в момент события, вместо того чтобы ваш код каждые несколько минут спрашивал нас, не случилось ли что-нибудь. Доступно тридцать одно событие, каждая доставка подписана, сбои повторяются, а журнал показывает, что именно ответил ваш эндпоинт.
На практике разница в задержке и стоимости. Задание опроса, которое запускается каждые пять минут, и опаздывает на пять минут, и в основном шлёт впустую. Вебхук приходит меньше чем за секунду и только тогда, когда есть что сообщить.
У каждого эндпоинта свой секрет. Мы вычисляем HMAC-SHA256 тела запроса с этим секретом и отправляем его в заголовке подписи; ваш получатель вычисляет его заново и сравнивает. Запрос без совпадающей подписи нужно отклонять.
Сравнивайте за постоянное время, а не обычным сравнением строк, и обращайтесь с секретом как с паролем: это единственное, что стоит между вашим эндпоинтом и любым, кто угадает URL.
Ответ с кодом не из диапазона 2xx или тайм-аут помечают доставку как неудачную, и она повторяется с нарастающей задержкой. Это покрывает обычные случаи: деплой, перезапуск, кратковременную блокировку базы данных.
Раз повторы существуют, ваш обработчик должен быть идемпотентным. Проектируйте его так, чтобы повторное получение того же события давало тот же результат, что и однократное, обычно с опорой на id события. Это верно для любой системы вебхуков, и именно эта ошибка чаще всего проявляется в виде дублей записей.
Исходящие вебхуки, до двадцати эндпоинтов, входят в тариф Business, как и публичный REST API, который работает с ними в паре. Если вы вообще не хотите писать получатель, интеграции с Zapier и n8n получают те же события на том же тарифе. Актуальные цены на странице с ценами.
Читайте и меняйте записи, о которых сообщают события.
Дайте ИИ-клиенту управлять рабочим пространством.
Те же события, без своего получателя.
Автоматизация на своём сервере с теми же данными.
Откуда приходит событие о нарушении SLA.
Лимиты эндпоинтов на каждом тарифе.
Готово к запуску
Вебхуки и REST API входят в тариф Business.