Building Webhooks for Publive: Empowering Publisher Integration
Publive introduces powerful webhooks designed to streamline interactions and enhance operational efficiency for publishers. These webhooks enable seamless integration with external systems, allowing publishers to stay informed and take immediate action on critical events within Publive.
Overview
Webhooks in Publive function by triggering HTTP POST requests to user-defined URLs, providing real-time notifications whenever specified events occur. These events range from content updates to member activities, ensuring that publishers can promptly respond to changes and updates in their ecosystem.
Setting up a Webhook
Setting up a webhook in Publive is straightforward and can be managed directly through the Publive Configuration user interface. Key components include:
Target URL: This is the endpoint where Publive will send POST requests. It must be a publicly accessible URL.
Events: Publishers can subscribe to various events to trigger webhook notifications. Examples include content updates, member activities, and more.
Upon triggering an event, Publive sends a JSON payload to the configured endpoint, containing detailed information about the event. This data can facilitate actions ranging from simple notifications to complex system integrations.
Available Events
Publive supports a comprehensive range of events that publishers can subscribe to via webhooks:
Content Management: Events related to posts, tags, categories, and site changes.
Member Activities: Events such as member additions, edits, and deletions.
Reader Engagement: Includes activities like newsletter subscriptions, downloads, and interactions with paywall content.
User-Generated Content (UGC): Notifications for submissions, approvals, and publication of user-generated content.
Navigation Updates: Updates to website navigation elements like navbar and footer.
Notifications: Events related to push notifications and newsletter campaigns.
Event | Description |
---|---|
site.changed | Triggered whenever any content changes in your site data or settings |
post.added | Triggered whenever a post is added to Publive |
post.deleted | Triggered whenever a post is deleted from Publive |
post.edited | Triggered whenever a post is edited in Publive |
post.published | Triggered whenever a post is published to Publive |
post.published.edited | Triggered whenever a published post is edited in Publive |
post.unpublished | Triggered whenever a post is unpublished from Publive |
post.scheduled | Triggered whenever a post is scheduled to be published in Publive |
post.unscheduled | Triggered whenever a post is unscheduled from publishing in Publive |
post.rescheduled | Triggered whenever a post is rescheduled to publish in Publive |
tag.added | Triggered whenever a tag is added to Publive |
tag.edited | Triggered whenever a tag is edited in Publive |
tag.deleted | Triggered whenever a tag is deleted from Publive |
member.added | Triggered whenever a member is added to Publive |
member.edited | Triggered whenever a member is edited in Publive |
member.deleted | Triggered whenever a member is deleted from Publive |
reader.added newsletter.subscribe | Triggered whenever a reader signup and also triggered newsletter subscribe |
reader.downloaded | Triggered whenever reader data downloaded |
newsletter.subscribe | Triggered whenever a reader subscribe newsletter |
newsletter.unsubscribe | Triggered whenever a reader unsubscribe newsletter |
newsletter.sent | Triggered whenever newsletter campaign sent |
category.added | Triggered whenever a category added to Publive |
category.edited | Triggered whenever a category edited in Publive |
category.deleted | Triggered whenever a category is deleted from Publive |
paywall.subscription.subscribe | Triggered whenever a reader subscribe for paywall content on publive |
paywall.subscription.expired | Triggered whenever reader subscription expired |
paywall.subscription.renewed | Triggered whenever reader subscription renewed |
ugc.post.submission | Triggered whenever a ugc submission received |
ugc.post.seen | Triggered whenever a ugc submission seen |
ugc.post.approved | Triggered whenever a ugc submission approved |
ugc.post.published | Triggered whenever a ugc submission published |
navigation.navbar.edited | Triggered whenever an edit occur in navbar |
navigation.footer.edited | Triggered whenever an edit occur in footer data |
pushnotification.sent | Triggered whenever an push notification sent on publive |
Integration with Zapier
Publive web hooks seamlessly integrate with Zapier, empowering publishers to automate workflows and connect Publive events with over thousands of other apps. For instance, when a new article is published (post.published
), Zapier can automatically trigger actions based on predefined rules, such as sending notifications or updating external databases.
Sample Prefill Data
When a post is published (post.published
), the webhook payload includes essential metadata about the article, such as:
{ "title": "testing batching for newsletter locks", "legacy_url": "/ignore/testing-batching-for-newsletter-locks-2739", "banner_url": "https://img-cdn.thepublive.com/demo/media/media_files/CphhvD4a3E1B736yCjXy.png", "type": "Article", "status": "Published", "absolute_url": "https://demo.lvh.me:8081/ignore/testing-batching-for-newsletter-locks-2739" }
This data enables integrations to immediately act upon published content, enhancing publisher productivity and engagement.
Publive’s robust webhook system empowers publishers with real-time insights and operational efficiency, ensuring seamless integration with external systems and enabling swift action on critical events. By leveraging Publive webhooks, publishers can automate workflows, enhance user engagement, and stay ahead in a dynamic digital publishing landscape.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article