Webhook Jinja Templating Custom Fields

[aascedu]

Hello,

I want to use Jinja templating in the webhook body.
I have a webook set to trigger when a VLAN object is created. I also have a custom field for Tenant objects called TenantID.
The webhook communicates with my ERP and I have successfully created a vlan in my ERP when I write this TenantID with a default static value lets say 123.

However each and every VLANs could be for different Tenants, so I need to fetch TenantID for the tenant of the vlan created.
Here is a view from the API (URL/api/ipam/vlans/) :

{
            "id": 25,
            "url": "URL/api/ipam/vlans/25/",
            "display_url": "URL/ipam/vlans/25/",
            "display": "Data (1)",
            "site": {
                "id": 116,
                "url": "URL/api/dcim/sites/116/",
                "display": "Aix",
                "name": "Aix",
                "slug": "Aix",
                "description": ""
            },
            "group": {
                "id": 24,
                "url": "URL/api/ipam/vlan-groups/24/",
                "display": "APAJH 38-Aix-Vlans",
                "name": "APAJH 38-Aix-Vlans",
                "slug": "apajh-38-aix-vlans",
                "description": ""
            },
            "vid": 1,
            "name": "Data",
            "tenant": {
                "id": 1,
                "url": "URL/api/tenancy/tenants/1/",
                "display": "APAJH 38",
                "name": "APAJH 38",
                "slug": "apajh-38",
                "description": ""
            },
            "status": {
                "value": "active",
                "label": "Active"
            },
            "role": null,
            "description": "",
            "comments": "",
            "l2vpn_termination": null,
            "tags": [],
            "custom_fields": {},
            "created": "2024-11-12T10:35:04.597269Z",
            "last_updated": "2024-11-12T10:35:04.597289Z",
            "prefix_count": 1
        },

As you can see there is no field "custom_fields" in the tenant dict...
Would I be able to get it with Jinja2 templating ?
With netbox shell I can do that : vlan.tenant.custom_field_data.get('TenantID') and it returns the value.

Thanks so much for any solutions provided !

[Ferdbugs]

Hi, I noticed this issue has been closed. Did you manage to figure this one out ? Thanks!

[aascedu]

Yes, I figured it out, but it is messy. I think this is really not the way to go.

My webhook is triggered when a VLAN Object is created. Since I needed the django methods of this object, I created a netbox script that would receive exactly the infos I needed from the webhook and then did whatever I wanted it to, fetching the custom field data ? easy in a netbox script.

The webhook would trigger this script :

class WebhookVLAN(Script):
    class Meta:
        name = "VLAN"
        description = "VLAN webhook"
    CompteID = StringVar(
        description="Numero de Compte",
        required=True,
        label="CompteID",
    )
    EtsID = StringVar(
        description="Numero de Ets",
        required=True,
        label="EtsID",
    )
    FamilleID = StringVar(
        description="Famille de l'envtech",
        required=True,
        label="FamilleID",
    )
    CatID = StringVar(
        description="Categorie de l'envtech",
        required=True,
        label="CatID",
    )
    DesignationID = StringVar(
        description="Designation de l'envtech",
        required=True,
        label="DesignationID",
    )
    Frn_PrsLib = StringVar(
        description="Libellé fournisseur",
        required=True,
        label="Frn_PrsLib",
    )
    Cli_PrsLib = StringVar(
        description="Libellé client (Vlan Name)",
        required=True,
        label="Cli_PrsLib",
    )
    Ref_PrsCode = StringVar(
        description="Vlan ID",
        required=True,
        label="Ref_PrsCode",
    )
    def run(self, data, commit):
        url = url
        headers = {
        "Content-Type": "application/json"
        }
        CompteID = Tenant.objects.get(id=data['CompteID']).cf.get('CompteID')
        EtsID = Site.objects.get(id=data['EtsID']).cf.get('EtsID')
        data = {
            "CompteID": CompteID,
            "EtsID": EtsID,
            "FamilleID": data["FamilleID"],
            "CatID": data["CatID"],
            "DesignationID": data["DesignationID"],
            "Frn_PrsLib": data["Frn_PrsLib"],
            "Cli_PrsLib": data['Cli_PrsLib'],
            "Ref_PrsCode": data["Ref_PrsCode"],
        }
        json_data = json.dumps(data)
        auth = requests_gssapi.HTTPSPNEGOAuth()
        try:
            response = requests.post(url, headers=headers, data=json_data, auth=auth, verify=False)
            response.raise_for_status()
            self.log_info("Response content:", response.text)
        except requests.exceptions.RequestException as e:
            self.log_failure(f"An error occurred: {e}")

and the webhook body :

{
  "data": {
    "CompteID": "{{ data.tenant.id }}",
    "EtsID": "{{ data.site.id }}",
    "FamilleID": "klm",
    "CatID": "hij",
    "DesignationID": "efg",
    "Frn_PrsLib": "abc",
    "Cli_PrsLib": "{{ data.name }}",
    "Ref_PrsCode": "{{ data['vid'] }}"
  },
  "commit": false
}

Hope it can help...

[Ferdbugs]

Thanks a bunch for your response! Yeah, agreed on that. It would be much more seamless if we could retrieve the data in the webhook directly.

[aascedu]

Thanks a bunch for your response! Yeah, agreed on that. It would be much more seamless if we could retrieve the data in the webhook directly.

It could be seamless indeed but I think the webhook calling a script that knows what to do is alright in this case