UBX supports registering your business solution as a custom endpoint. You build custom
endpoints separately in response to each registration request. This approach does not define your
solution as a UBX application with globally accessible features.
Note: Registering endpoints as custom endpoints is not recommended for new integrations with UBX. It
is documented here to support legacy integrations.
As a UBX partner and endpoint provider, building custom endpoints – instead of basing the
endpoints on a UBX application definition – means that you must build a separate endpoint for each
registration request. If the endpoint changes, you must individually update the endpoint
registration for every UBX user account that has registered the custom endpoint. For example, if you
begin to support a new event type or identifier six months after you are provisioned as a UBX
endpoint provider, you must separately update the registrations for every UBX user account that
registered your endpoint as a custom endpoint during the previous six months.
To build each endpoint, you must call the v1/endpoint API to describe the
endpoint and to describe events or audience data that it can provide. UBX uses the information from
the API call to present the endpoint as an option in the UBX user interface.
UBX communicates with endpoints through APIs and HTTPS. If your application or service requires
authenticated access, call the v1/endpointattributes API to provide UBX with
the specific credentials that you require to establish a secure connection.
Creating a custom endpoint requires calling UBX public endpoint APIs that are different
from the v1/application APIs that you call to create and provision endpoints as UBX applications.
You call the endpoint APIs separately for each UBX user that registers your endpoint as a custom
To register your business solution as a custom endpoint requires that you call the
v1/endpoint and v1/endpointattributes APIs.
You must individually define the endpoint for each UBX user that registers your business solution
in UBX. This means that you must call v1/endpoint and
v1/endpointattributes for each request. If you make changes to the endpoint,
for example, to support a new identifier in the audience data, you must update each registered