What’s new in this API version?

In version 11 of the Subscriptions API, we have improved the following in contrast to version 10:

  • Subscription management is now synchronous. Creating, updating, and deleting subscriptions no longer goes through the process status mechanism. These operations now complete immediately — you no longer need to poll a process status endpoint to confirm that your subscription was created, updated, or deleted.

  • The subscription destination field is renamed from url to eventDestination. The field that specifies where notifications should be delivered is now called eventDestination. This name more accurately describes its purpose across all delivery methods (webhooks, GCP Pub/Sub, and AWS SQS), where the value is not always a URL.

  • The test push notification endpoint now returns a confirmation response. When you send a test notification, the API now returns a response body containing the resourceId, resource, and type of the test message that was dispatched. This allows you to confirm exactly what was sent without having to poll a process status endpoint.