How do I define a webhook to call the Vibes API? | Community
Skip to main content
G
Guitarrista82
Level 6
September 6, 2023
Solved

How do I define a webhook to call the Vibes API?

  • September 6, 2023
  • 2 replies
  • 3869 views

Hello,

 

I am asking a developer question because, while we have developers, it takes months to have changes made and things built. So our small technical team works to try and get things built faster.

 

I am trying to set up webhooks in Marketo that will 1. Get data from the Vibes sms/mobile wallet platform and 2. Update Marketo records with that data.

 

I've been reading through the API documentation for both Marketo and Vibes and am still unsure of how to accomplish this.

 

I've created a webhook to accomplish the first part, to Get the Vibes data, which would be the External Person ID circled in the second screenshot below.

 

First, I'm not sure that the webhook is set up correctly, and second I don't know how to update the field below in Marketo with the External Person ID that resides in Vibes.

 

Is it possible to update this field using the same webhook or would I need to create a Post webhook to update that field?

 

 

Thank you,

LK

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.
Best answer by Darshil_Shah1

Hi Darshil,

 

I attempted to use the "Add a person" API call you suggested. When I test it on this page https://developer-platform.vibes.com/reference/post_add-a-person it works fine, but when I test in Marketo   all I get is the activity log below and no confirmation that the webhook was sent or failed.



I added the correct headers shown on the documentation for "Add a person": 


 

Does the order that the headers are in matter? Here's how they are set up in the webhook in Marketo?

 

Thank you,

LK


@guitarrista82, as a first step, please edit your post and redact/mask any credentials/API key. It's really not advisable to post any of those in a public forum. The order of headers doesn't matter, as long as all the headers are included, you should be fine. You might want to update your response mapping, as from what I see on the documentation, mdn is an attribute within the mobile_phone object (mobile_phone.mdn). You might also want to select the Response Type to JSON in the webhook definition. Also, sometimes I've seen the webhook definition getting cached by Marketo, so I usually like to create a new webhook, and keep the existing one as the older version (helps with the versioning as a silver-lining) if I run into errors/get no output. Also, are you able to check the campaign queue and verify whether the campaign you requested is still in the queue? Because, if the campaign you requested has a Webhook call step in its flow, then you should technically see the Call Webhook activity in the person's activity log.

2 replies

Darshil_Shah1
Community Advisor and Adobe Champion
Darshil_Shah1Community Advisor and Adobe Champion
Community Advisor and Adobe Champion
September 6, 2023

Are you trying to make a webhook call to the Find person by MDN (Mobile Directory Number) vibes API from Marketo? A couple of items below you should re-check in the documentation and rectify in your webhook definition in Marketo:

  • You only need "&" to separate the 2nd query parameter onwards, for the first QP, you should be using "?" after the base URL. You're also probably missing the query parameter's attribute (unless you have that included in the Phone Number field, which I highly doubt).

 

https://public-api.vibescm.com/companies/company_key/mobiledb/persons?mdn={{lead.mobile phone number}}

 

  • Per the API documentation, external_person_id attribute has the unique person identifier assigned by the brand, which can be used to link non-Vibes-assigned identifiers to Vibes person records. I think you should be using this instead of the foo attribute in the response mapping table.
  • You're missing the X-API-Version header. Check the CURL on the documentation page, it has the X-API-Version header included. Also, the documentation specifies using the accept header and not the Content-Type header.

 

Is it possible to update this field using the same webhook or would I need to create a Post webhook to update that field?

 

 

Thank you,

LK

You don't really need a POST call to update the Marketo field with the "Vibes Id". As long as the Vibes API call includes the required ID in its response, you can map the incoming response attribute with the Vibes Id Marketo field. You'd do that in the webhook call's Response Mapping section (Webhook's Response Mapping uses the SOAP field name).

G
Guitarrista82Author
Level 6
September 6, 2023

Hi Darshil,

 

Thanks for your help!

 

Yes, I am trying to first locate the contact in Vibes by using the mobile phone number (called MDN in Vibes), grab the External Person ID that lives in Vibes and then in Marketo I want to update the {{Lead.Vibes ID}} field with the External Person ID info that is in Vibes. 

 

Unfortunately, the External Person ID that is in Vibes does not exactly match the ID, {{Lead.ID}}, that is in Marketo. The External Person ID simply contains the {{Lead.ID}} like this:  mkto:512-JJP-615:53435840

 

 

So what I'm trying to do is grab that External Person ID from Vibes and then copy it to the Lead.Vibes ID field that I created so that I can then use a separate webhook here to update the custom fields I have created in Vibes with Marketo data.

 

I reconfigured my GET webhook as shown below based on your feedback:

 

Does this look correct considering what I'm trying to accomplish?

 

Thank you,

LK

Darshil_Shah1
Community Advisor and Adobe Champion
Darshil_Shah1Community Advisor and Adobe Champion
Community Advisor and Adobe Champion
September 7, 2023

I still think you've got discrepancies with your headers. Below are the headers mentioned in the documentation page, which you should also be adding to your webhook definition:

--header 'X-API-Version: 1' \ --header 'accept: application/json' \ --header 'authorization: Basic <key>'

Additionally, it's not expected of any system that they'd have their identifier values (External Person Id in this case) the same as those of records in Marketo (Person Id).

 

Why don't you directly upsert the data using the Add a Person API call? This endpoint can very well identify people based on their MDN or External Person Id values, and since you already have MDN data in Marketo, you can bypass the Find person by MDN GET call to get the External Person Id first. If an existing person record already exists with the same mobile_phone. The record will be updated with the added information. Specified fields in the add request will be applied and any existing data fields on the record will remain unchanged.

SanfordWhiteman
SanfordWhiteman
Level 10
September 6, 2023

Expanding on Darshil’s point, you really need to understand URL structure if you’re dealing with webhooks (or really with building URLs in general).

 

This URL:

 

 

https://api.example.com/person&212-555-1212

 

 

 

Could not be more different from this URL:

 

 

https://api.example.com/person?212-555-1212

 

 

 

The first has the pathname /person&212-555-1212. It has no query string.

 

The second has the pathname /person. It has the query string* ?212-555-1212. It has the query parameter 212-555-1212 with an empty value.

 

If a service is expecting the second URL it’s quite likely it will throw a 404 on the first, and vice versa.

 

 

* sometimes the query string is expressed with the leading ?, sometimes without, but they’re parsed identically

    G
    Guitarrista82Author
    Level 6
    September 8, 2023

    Thank you Sanford! That was my bad with the URL configuration. I know how to configure them correctly--it was a mistake.

     

    Appreciate your input!

     

    LK

    Terms & ConditionsAccessibility statement

    Loading footer...