Zype provides a Webhook Service that allows developers to receive webhook notifications at a target URL / server of their choosing based on common events within the Zype platform. This helps developers create powerful integrations with the Zype platform, such as easily syncing data between Zype and their own databases, or triggering updates to consumer-facing applications based on webhook events.
Supported Webhook Event Types
Zype's Webhook Service supports triggers based on the following event types:
| Webhook Event | What triggers the webhook | What's included in the webhook payload |
| New consumer created | Generated any time a new consumer is created in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full consumer object, which can be referenced in Zype's consumers API. |
| Consumer updated | Generated any time a consumer is updated in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full consumer object, which can be referenced in Zype's consumers API. |
| Consumer deleted | Generated any time a new consumer is deleted from your Zype account (either via API or manually) | We send the event type as well as the full consumer object, which can be referenced in Zype's consumers API. |
| Subscription created | Generated any time a consumer purchases a new subscription plan in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full consumer object and subscription plan object, which can be referenced in Zype's consumers API. |
| Subscription updated | Generated any time a consumer updates a subscription plan in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full consumer object and subscription plan object, which can be referenced in Zype's consumers API. |
| Subscription deleted | Generated any time a consumer cancels a new subscription plan in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full consumer object and subscription plan object, which can be referenced in Zype's consumers API. |
| Transaction created | Generated any time a consumer completes a transaction in your Zype account (either via API, embeds, or manually) -- includes purchase, rental, and pass plans. | We send the event type as well as the full consumer object and transaction object, which can be referenced in Zype's consumers API. |
| Video created | Generated any time a video is created in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full video object, which can be referenced in Zype's consumers API. |
| Video updated | Generated any time a video is updated in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full video object, which can be referenced in Zype's consumers API. |
| Video deleted | Generated any time a new video is deleted from your Zype account (either via API or manually) | We send the event type as well as the full video object, which can be referenced in Zype's consumers API. |
| Playlist created | Generated any time a playlist is created in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full playlist object, which can be referenced in Zype's consumers API. |
| Playlist updated | Generated any time a playlist is updated in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full playlist object, which can be referenced in Zype's consumers API. |
| Playlist deleted | Generated any time a new playlist is deleted from your Zype account (either via API or manually) | We send the event type as well as the full playlist object, which can be referenced in Zype's consumers API. |
| Category created | Generated any time a category is created in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full category object, which can be referenced in Zype's consumers API. |
| Category updated | Generated any time a category is updated in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full category object, which can be referenced in Zype's consumers API. |
| Category deleted | Generated any time a new category is deleted from your Zype account (either via API or manually) | We send the event type as well as the full category object, which can be referenced in Zype's consumers API. |
| User created | Generated any time a user is added to your Zype account (either via API, embeds, or manually) | We send the event type as well as the full user object, which can be referenced in Zype's consumers API. |
| User updated | Generated any time a user is updated in your Zype account (either via API, embeds, or manually) | We send the event type as well as the full user object, which can be referenced in Zype's consumers API. |
| User deleted | Generated any time a new user is deleted from your Zype account (either via API or manually) | We send the event type as well as the full user object, which can be referenced in Zype's consumers API. |
How to Enable Zype's Webhook Service
Getting started with Zype's Webhook Service is easy to do and takes just a couple of clicks.
Step 1 - Set up your webhook target URL
- To begin, go into Zype admin and visit the main settings page.
- Click into the Webhook Events tab
- Enter your target server URL where you would like to receive webhook payloads from Zype
- Hit 'Save Changes'
Step 2 - Test webhook event notifications
- We've built a handy webhook event test function if you'd like to test sample webhook events during integrations / implementation.
- This will help you determine which event types you'd like to integrate with, and ensure you're able to properly receive and process webhook events as they are generated.
Step 3 - Select which webhook events you would like to receive
- You can choose which webhook events you'd like to receive by checking the corresponding boxes next to each event type.
- Once you've made your selections, click 'Save Changes'
That's it! You should now be ready to receive webhook events for any event types that you've selected.
0
0
Was this article helpful?
0 out of 0 found this helpful