Developer Guide

Discovering Extensions

There are at least two situations in which you need to determine if a specific tenant in your system has an existing extension of a specific extensibility point:

The same GET /api/webtask/{container} Extend management API can be used in both cases. The API allows you to list all extensions that exist in a specific webtask container, and allows you to optionally specify further filtering criteria. You can use this capability to filter the list down to extensions with a specific value of the auth0-extension-type metadata property that stores the name of the extensibility point in your system.

To find out all extensions defined in a specific webtask container (i.e. for a particular tenant), issue:

GET {host_url}/api/webtask/{webtask_container}
Authorization: Bearer {tenant_webtask_token}

To find out all extensions associated with a specific extensibility point in your platform, issue:

GET {host_url}/api/webtask/{webtask_container}?meta=auth0-extension-type:{extensibility_point_name}
Authorization: Bearer {tenant_webtask_token}

The following parameters must be provided in this call:

A successful response to these API calls will contain a JSON array with objects representing matching extensions. For each extension, you will get:

  • name: the name of the webtask implementing this extension.

  • host_url: the HTTPS URL for your Extend instance.

  • meta: an object representing all metadata properties of this webtask associated with it at creation time.

See discoverExtensions function from a sample Extend application.