Using the User Events API (early access) Follow



  • Avatar
    Thomas Verschoren

    If the Proporties contain an URL value, is there a way to display a link?


    E,g. we have now linked Freshbooks Estimate creations to user tickets.

    Would be useful to embed a link back to the freshbooks item so we can quickly see the invoice.

    I tried doing an HTML escaped href= but that just added text.

  • Avatar
    Charles Nadeau

    Hi Thomas, you might also try cross-posting your question in the Events API forum:


  • Avatar
    Cheng Ying Tang

    Hi Thomas,

    I'm assuming you are referring to the Customer Context timeline rendering links, as if you were just using the API you would be able to render it in whichever way you would like it.


    Adding a link that is clickable during the hover state is certainly a possibility. I will bring this up with our front end engineer!

  • Avatar
    Thomas Verschoren

    An example will make it clearer:


    I use the following json to create an Event

    "user_id": "12345",
    "type": "newinvoice",
    "source": "freshbooks",
    "description": "New Invoice 2018/01",
    "created_at": "2018-12-13T17:51:00Z",
    "properties": {
    "amount": "98.74",
    "link": ""

    But having the link at least clickable, or replacable with

    {title: "invoice 123", url:""} would be neat.

  • Avatar
    Sander Verhaeven



    Would it be possible to show the source of an event in interface? It would be nice if we could set an icon as well.

    "user_id": "11962081749",
    "source": "Akti",
    "type": "Planned_Intervention",
    "created_at": "2018-11-05T22:26:00Z",
    "description": "Plan Intervention"

    would result in 

  • Avatar
    Billy Kong (Edited )

    Hi I am testing this api by using user emails to save an event. On zendesk support user ticket, I cannot see where the event is being displayed. Any help here? The get request returns me a json with the event I saved but I cannot see it on zendesk.


    edit: i see the interactions tab but it is not updating with saved events

  • Avatar
    Bryan Flynn (Edited )

    @Thomas, @Sander, @Billy -- Since it looks like you're talking about the new Interaction feature in the agent UI and how it uses event data, I suggest posting issues at Viewing customer context in a ticket. The product managers are monitoring that space more closely and answering feedback regarding this new agent UI feature there.

    For questions related directly to the Events API, then posting on the community area's Events API (beta) page is best.

  • Avatar
    Marlene Hirose (Edited )

    I'm attempting to use: GET /api/cdp/events?user_id={id} using our credentials and such

    And all I get is this: 

    {"id":1020,"reason":"Profile not found"}

    What am I doing wrong?

  • Avatar
    Bryan Flynn

    Hi Marlene -- if you're following the above example:

    curl 'https://{{subdomain}}' \
      -H "Accept: application/json" \
      -v -u {email_address}:{password}

    ... and assuming you're authenticated in correctly and your account has been given permission for this feature (it's an "early access program"/beta feature, so not everyone has access to it), then I'd say you probably need to open a ticket with There are probably things against your account that need to be checked beyond what can be done or shared in a public post.

  • Avatar
    Marlene Hirose

    thank you, Bryan. I shall do that

Please sign in to leave a comment.

Powered by Zendesk