Getting Started with Plytix Webhooks

Understanding Webhooks and how to use them in Plytix

Webhooks are a handy tool to automate notifications in third-party apps after a Plytix channel is processed. This feature allows you to receive real-time updates about your channel processing, so you can integrate Plytix with the tools your team uses.

 

What Are Plytix Webhooks?

Setting up a Webhook in Plytix

Technical Information

Use Cases for Webhooks

 

*Skip to any section in this article by clicking on the links above

---

What Are Plytix Webhooks?

Webhooks are automated messages sent from Plytix to a URL of your choice when certain events occur—in this case, when a channel is processed. They allow your other systems to be immediately notified and take action based on this information, without needing to constantly check Plytix for updates.

 

---

Setting Up a Webhook in Plytix

To set up a webhook:

1. Log in to your Plytix account.

2. Navigate to the settings of the channel you want to receive external updates about.

3. Look for the Webhook section and click on the option to create a new webhook.

4. You'll be prompted to enter a Request URL. This is where Plytix will send the webhook data.

   

5. Save your webhook configuration.

---

Technical Information

Here are the key technical aspects of Plytix webhooks:

• REQUEST URL: The URL you provide where Plytix will send the webhook data.
• METHOD: Plytix uses the POST method to send webhook data.
• REQUEST BODY: The data is sent in JSON format. Here's an example of the structure:
  
  

{
  "channel_name": "Example channel",
  "channel_processing_status": "success",
  "channel_url": "https://pim.plytix.com/example-channel",
  "feed_url": "https://pim.plytix.com/example-channel/feed",
  "processed_products": 452
}

 

Webhook Payload

The webhook payload contains four key pieces of information:

1. channel_name: The name of the processed channel.
2. channel_url: The URL of the channel in Plytix.
3. channel_processing_status: The status of the channel processing (i.e., "success").
4. processed_products: The number of products processed in the channel.
5. feed_url: The URL of the file containing the products, if it is from a channel that generates a feed.

Testing Your Webhook

Plytix provides a "Test Webhook" feature that allows you to send a test payload to your specified URL. This helps ensure that your endpoint is correctly set up to receive and process the webhook data before activating it for real channel processing events.

Here are a few things to consider when using Webhooks in Plytix:

• The webhook method (POST) and the request body structure are not customizable in the basic webhook setup.
• Ensure that the endpoint URL you provide is secure and capable of handling POST requests from Plytix.
• The endpoint should be able to process the JSON payload as described above.

---

Use Cases for Webhooks

Plytix webhooks can be used in various ways to enhance your workflow:

• Trigger email notifications when a channel is processed.
• Update external dashboards or reporting tools with real-time channel processing data.
• Initiate follow-up processes in your other systems based on successful channel processing.
• Log channel processing activities in external databases or monitoring tools.

Those use cases can be easily configured connecting Plytix webhooks with tools like Zapier, Make, ActiveCampaign, Hubspot or Parabola. 

This way, you can integrate channel updates in Plytix with other tools your team uses. By leveraging this feature, you can create more efficient, automated processes that keep your team informed and your data synchronized across your entire tech stack.

---

What's Next?

• Learn how to set up Plytix Webhooks with Make
• Learn how to set up Plytix Webhooks with Zapier
• Learn how to manage your Plytix channels