Към съдържанието
Rex, вашият AI асистент: рутината е поета, идеите са ваши 👉 Запознайте се с Rex

Изпращайте данни към своите системи чрез уебхукове

Получавайте заявка към свой собствен URL адрес, когато някой се регистрира, участва или спечели – с подписани данни, Basic Auth, персонализирано съдържание и дневник на всяка доставка.

Уебхукът изпраща данни към избран от вас URL адрес в момента, в който нещо се случи – например когато някой участва в кампания или спечели награда. Вашият разработчик настройва системата, която ги получава.

Уебхуковете са част от плановете, които включват Webhooks & API (Basic и по-високи).

Уебхукове за кампания или за акаунта?

  • Уебхуковете за кампания се настройват в редактора на кампанията и се задействат само за нея. Те имат събитията „Every time a lead participates in a campaign“ и „When a lead wins a prize“, както и най-много опции.
  • Уебхуковете за акаунта се настройват от Settings > Webhooks. Те имат събитието „When a new lead is created“: задейства се веднъж за всеки човек – първия път, когато бъде добавен към вашите лийдове, независимо от коя кампания идва.

Добавяне на уебхук към кампания

  1. Отворете кампанията в редактора и отидете в Connect > Webhooks.
  2. Кликнете Add webhook.
  3. Въведете Payload URL. Той трябва да започва с https: „We only support webhooks over HTTPS to ensure that the data sent remains secure.“
  4. Изберете Content type: application/json или application/x-www-form-urlencoded.
  5. Изберете Method. По подразбиране формата е на GET, при който данните се изпращат в URL адреса. Изберете POST, за да ги изпратите в тялото на заявката – това очакват повечето системи.
  6. В Authentication (само за POST) изберете Basic Auth, ако вашият URL изисква потребителско име и парола, и попълнете Username и Password. В противен случай оставете None.
  7. Въведете Secret, за да подписвате заявките (препоръчително). Вижте „Проверка на подписа“ по-долу.
  8. Включете Log response body, ако искате да виждате какво отговаря вашата система. „Enable to store the response body for debugging.“
  9. Оставете Active включено. „We will only deliver events if the webhook is active.“
  10. Изберете събитието: „Every time a lead participates in a campaign“ или „When a lead wins a prize“.
  11. Включете Custom payload, ако искате сами да определите полетата (вижте по-долу).
  12. Кликнете Add webhook. Ще видите „Webhook added“.

Панелът Webhooks показва уебхуковете на кампанията със статус Active или Inactive, както и Last delivery failed, ако последната заявка е неуспешна. Използвайте Actions, за да изберете Edit, See deliveries или Delete за даден уебхук. Когато редактирате уебхук, оставете Secret празно, за да запазите текущия.

Добавяне на уебхук за акаунта

  1. Отидете в Settings > Webhooks (в раздел Developers). Вашите уебхукове са изброени в My webhooks (или под името на всеки списък с лийдове, ако имате няколко).
  2. Кликнете картата с плюс, за да добавите уебхук. Прозорецът Add webhook гласи „Send a request to an external URL whenever selected events happen.“
  3. Попълнете Payload URL, Content type („Select content type of the webhook“), Method и Secret както по-горе.
  4. В Which events should trigger the webhook? изберете „When a new lead is created“.
  5. Отметнете „Yes, allow me to specify a customized payload (Advanced users only)“, ако искате собствени полета.
  6. При нужда отметнете Log response body („This webhook will log the response body“) и оставете Active отметнато („We will deliver event details when this hook is triggered“).
  7. Кликнете Add webhook.

Кликнете уебхук, за да го промените (Save changes), да зададете New secret, да отворите Show deliveries или да изберете Delete webhook („This action cannot be reverted!“).

Какво се изпраща

По подразбиране тялото съдържа event (името на събитието: lead_created_on_campaign, new_campaign_winner или lead_created) и обект data:

  • campaign: id и name на кампанията (уебхукове за кампания)
  • lead: полетата от формата на лийда по техния ключ (например first_name), плюс id, phone_number и created_at
  • lead.permissions: за всяко поле за съгласие – дали е прието, текстът, датата и IP адресът (уебхукове за кампания)
  • participant: каналът (channel), от който е дошъл човекът, и кога е участвал (уебхукове за кампания)
  • quiz: отговорите на именуваните въпроси от куиза, също и под четими имена, започващи със „Simple“
  • prize: id, name, value, coupon_code на наградата и кога е спечелена (уебхукове за победители)

Празните стойности се пропускат, както и съгласията, които не са приети. При метода GET същите данни се изпращат като параметри на заявката в URL адреса.

Персонализирано съдържание

Когато Custom payload е включено, се изпращат само избраните от вас полета, без обвивката event.

  1. В Data mapping кликнете Add mapping.
  2. Въведете Field name, което очаква вашата система. Използвайте букви, цифри, тирета и долни черти.
  3. Изберете полето от Scratcher, което да се изпрати („Group → Field“), или Custom value и въведете фиксирана стойност в Value.
  4. Повторете за всяко поле. Премахнете поле с иконата на кошче (Remove или Remove data mapping).

Проверка на подписа

Ако сте задали Secret, всяка заявка има заглавка X-Hub-Signature: sha1=, последвано от HMAC-SHA1 хеш на кодираните в JSON данни (тялото, описано по-горе), с вашия Secret като ключ. Изчислете същото от ваша страна и сравнете, за да сте сигурни, че заявката идва от Scratcher.

Доставки и повторни опити

  • Ако вашият URL не отговори или върне грешка (статус 400 или по-висок), Scratcher опитва още два пъти: след 5 секунди и след една минута.
  • Пренасочванията не се следват, затова използвайте крайния URL адрес.
  • Отворете доставките (See deliveries в кампанията, Show deliveries за уебхуковете на акаунта), за да видите всяка заявка и отговор. Всяка доставка показва своето ID, Request и Response със статус кода (и Response body, ако го записвате). Използвайте copy, за да копирате съдържанието.
  • Включете Show only failed deliveries, за да виждате само проблемите. Най-горе се показва „Failed deliveries in the last 60 days“.
  • Кликнете Retry, за да изпратите доставката отново: „The webhook is being resent.“
  • „Webhook delivery logs are retained for 60 days.“

Отстраняване на проблеми

  • „The ... field must use HTTPS.“: Payload URL започва с http. Използвайте https.
  • Всички доставки са неуспешни без отговор: URL адресът не е достъпен от интернет, например локален или вътрешен адрес. Използвайте публичен URL.
  • Вашата система не получава данни: методът е GET, затова данните са в URL адреса. Превключете на POST.
  • Липсва поле, което системата ви очаква: то е било празно или съгласието не е прието. Настройте системата си да третира липсващите полета като празни.
Нужна ви е помощ?

Още имате нужда от помощ?

Истински хора са тук, за да помогнат. Ако вече използвате Scratcher, най-бързият начин е чатът в платформата.

  • Пишете ни в чата

    Влезте в профила си и натиснете бутона за чат в долния десен ъгъл. Rex отговаря веднага, а екипът ни е на едно кликване разстояние.

  • Запазете среща

    Безплатен 30-минутен видеоразговор с екипа ни: обиколка, идеи за кампании или помощ с настройката.

  • Пишете ни по имейл

    Пишете на contact@scratcher.io и ще ви отговорим.