topic Re: Webhooks | Custom payload using Liquid | Cant access child object in Network Platform API

Webhooks | Custom payload using Liquid | Cant access child object

SuperM — Wed, 06 Mar 2024 20:26:05 GMT

Hi All.

I am using the webhook payload template editor tool and for some reason unknown to me, I can not access the child object "uplink" I am using the same syntax as per the Meraki Docs.

LIQUID:

{
    "alert":"{{alertData.uplink}}"
}

The Error I get:

" Failed to load webhook payload template preview. Make sure you're using valid JSON format. ["Body Liquid error: undefined variable uplink"] "

The uplink value does exist:

LIQUID:

{
 "alert" : {{alertData | jsonify }}
}

JSON:

{
  "alert": {
    "uplink": "0"
  }
}

Example from Meraki docs which I followed to the "T":

https://developer.cisco.com/meraki/webhooks/custom-payload-templates-overview/#overview

Child object properties can also be accessed using the {{foo.bar}} syntax.

LIQUID:

{
    "port":"{{alertData.portNum}}"
}

JSON:

{
  "port": "3"
}

Any suggestions would be appreciated, not sure if it is a bug or if I am doing something wrong.

Re: Webhooks | Custom payload using Liquid | Cant access child object

matt_uc — Thu, 07 Mar 2024 22:20:02 GMT

This looks like it would work to me, and validates.

}

"uplink": "{{alertData|dig:"uplink"}}"

}

Re: Webhooks | Custom payload using Liquid | Cant access child object

SuperM — Fri, 08 Mar 2024 03:22:15 GMT

@matt_ucthanks that worked 😊

Re: Webhooks | Custom payload using Liquid | Cant access child object

DexterLabora — Fri, 08 Mar 2024 11:36:19 GMT

as @matt_uc correctly suggested:
https://developer.cisco.com/meraki/webhooks/custom-payload-templates-overview/#dig

The alertData property is ... special. Since every alert contains different properties, its sort of a black box to the template language. So, using the "dig" filter runs a function to pull this info out at runtime. That being said, if the nested property is declared, then using the dot.notation works.

We can update the documentation to make this more clear.