Webhooks are available by request for any BookFunnel account that includes integrations. If you have an integrations plan and would like to add webhooks, please contact support@bookfunnel.com to have that enabled.
Setup
Once the developer integration is enabled for your account, go to the Integrations tab on your dashboard and add a new integration. You should see BookFunnel API as a platform option. Once you’ve created an integration, you’re ready to go.
Edit the new integration you just created, and there you can set up your webhook. You will need to provide a URL where BookFunnel will send HTTP POST requests and then choose the format (JSON or form parameters) BookFunnel should send.
Webhooks
BookFunnel currently sends two webhooks: book_claimed and new_susbcriber. The new_subscriber webhook is fired any time someone subscribes to your newsletter through a BookFunnel opt-in landing page. The book_claimed webhook is fired any time someone claimed a book from a non-opt-in landing page.
Webhook Data
{
"event": "new_subscriber",
"email": "author@bookunnel.com",
"first_name": "Book",
"last_name": "Funnel",
"ip_address": "127.0.0.1",
"country_code": "US",
"country_name": "United States of America",
"page_id": "os1siq96bt",
"book_id": "17q6ag9sxj",
"download_code": "ALICE",
"download_link": "https://pr.bookfunnel.com/alice"
}
| event | The webhook event type: book_claimed or new_subscriber |
| first_name | The reader’s first name if the first name field is present on the landing page. |
| last_name | The reader’s last name if the last name field is present on the landing page. |
| ip_address | The reader’s IP address at the time of signup. |
| country_code | The reader’s two-digit country code based on their IP. |
| country_name | The reader’s full country name based on their IP. |
| page_id | The unique ID of the landing page the reader signed up from. |
| book_id | The unique ID of the book the reader received after signing up on the landing page. |
| download_code | The reader’s unique download code for this claim. |
| download_link | The reader’s unique download link for this claim. |