Custom Channels API - No option for HS_OBJECT_ID?

Developer Support APIs & Integrations
1

Hi there,

Using the Custom Channels API, is it possible to use the hs_object_id as the identifier?

In the JSON request body, you set the property “deliveryIdentifierTypes” for the custom channel. This only seems to accept the following values:

  • HS_EMAIL_ADDRESS
  • HS_PHONE_NUMBER
  • CHANNEL_SPECIFIC_OPAQUE_ID

I’ve tried each iteration of the HS_OBJECT_ID that I could think of to no avail. I can’t imagine why this method would not allow the use of the UID.

Can someone please assist?

2

Hey, @RM456 :waving_hand: Thanks for your question.

The short answer — no, the Custom Channels API does not currently support HS_OBJECT_ID as a deliveryIdentifierType. The only supported values (as defined in the documentation) are:
• HS_EMAIL_ADDRESS
• HS_PHONE_NUMBER
• CHANNEL_SPECIFIC_OPAQUE_ID

in this case, hs_boject_id is not a routable address like an email or phone number. Custom Channels expect something that points to an actual messaging endpoint.

You’ll need to use another solution if you must use a contact’s id. For example, maintain a lookup table that associates a contact’s hs_object_id with your channels user identifier (stored under CHANNEL_SPECIFIC_OPAQUE_ID). Your code or middleware would do the matching when you need to send messages or log events.

Unfortunately, the documentation doesn’t like the underlying why for situations that fall under “not possible”.

Best,

Jaycee

3

Hi @Jaycee_Lewis,

Thank you for your response and the breakdown, it is much appreciated.