Webhooks v3 provides organizations with the ability to manage the service the way they want to manage it. With Webhooks v3, organizations can do such things as:
- Create, delete, and modify webhook subscriptions.
- Start and stop delivery feeds.
- View events that have (and events that have not) been delivered.
All of these activities (and more) are carried out by making API calls; there's currently no GUI method for managing webhooks and webhook subscriptions. Because of that, managing Webhooks v3 means having a good understanding of how the webhook APIs work. Those APIs include the following endpoints:
- /{customerId}/webhooks/subscriptions/{subscriptionId}/events. Enables you to view all of your events in the Webhooks v3 event store; this includes both the events that have been delivered to your listener endpoint and the events that could not be delivered to your listener endpoint. Note that this endpoint is designed for testing and troubleshooting; it's not designed as an alternate way to monitor and download webhook events. That's the job of your listener endpoint.
- /{customerId}/webhooks/subscriptions/{subscriptionId}/events/{eventId}. Enables you to return information about a specific event. Note that this endpoint is designed for testing and troubleshooting; it's not designed as an alternate way to monitor and download webhook events. That's the job of your listener endpoint.
- /{customerId}/webhooks/subscriptions/{subscriptionId}/events/{eventId}/history. Enables you to return the delivery history for a specific event. The delivery history reports each delivery attempt, when that attempt was made, whether or not that attempt succeeded, and, in the case of delivery failures, why that attempt did not succeed. Note that this endpoint is designed for testing and troubleshooting; it's not designed as an alternate way to monitor and download webhook events. That's the job of your listener endpoint.
- /{customerId}/webhooks/subscriptions. Enables you to view and to create Webhooks v3 subscriptions.
- /{customerId}/webhooks/subscriptions/{subscriptionId}. Enables you to view, modify, or delete a webhooks subscription.
- /{customerId}/webhooks/subscriptions/{subscriptionId}/test. Enables you to send a test event to a your listener endpoint. This helps you verify that events are being delivered as expected.
- /{customerId}/webhooks/subscriptions/{subscriptionId}/events/{eventId}/redeliver. Enables you to reschedule delivery for any events that: 1) are still in the event store; and, 2) have been marked as failure..
We’ll explore these endpoints in more depth in a minute or two. Before we do that, however, we need to explain how those endpoints use authentication tokens.