Start SSOT job based on IP Fabric Webhook

[ghost]

Environment

• Nautobot version:
• nautobot-ssot-ipfabric version:

Proposed Functionality

IP Fabric allows for webhooks to send to external systems when discovery completes. It would be nice to have IPF send the webhook to Nautobot and that it automatically runs the SSOT job.

Use Case

[chadell]

You can trigger Jobs via API: https://nautobot.readthedocs.io/en/stable/additional-features/jobs/#via-the-api
is it good enough?

[ghost]

Unfortunately no as IP Fabric does not let you send custom responses. The endpoint receiving the webhooks must parse the data and then do automation against it.

https://ipfabric.atlassian.net/wiki/spaces/ND/pages/1456537601/Webhooks

[chadell]

So, if don't understand it wrong, the problem is that you can't add "data" or custom authorization to the request.
Actually, "data" is optional, we could create a Job that assumes the defaults, but authorization is mandatory, for any API endpoint in Nautobot.
Isn't any way to add it in the webhook?

[ghost]

Nautobot will need to process the webhook IP Fabric sends because it sends a message for every discovery action and status:
"action": "discover" | "clone" | "delete" | "download" | "load" | "unload", "status": "started" | "completed" | "failed" | "resumed" | "resumed (stopping)" | "stopped",

This will then possibly kick off an SSOT job for example when a snapshot action:delete/status:started which is incorrect. It needs to only kick off an SSOT job when action:discover, status:completed, requester:cron.

There is no way to add any authorization to the webhook. Nautobot will need to accept the event and verify the message:
The secret code is used to calculate the SHA256 HMAC payload hash which is sent inx-ipf-signature header. Using x-ipf-signature you can validate that request comes from correct server.

Full IP Fabric webhook message:
{ "type": "snapshot", "action": "discover" | "clone" | "delete" | "download" | "load" | "unload", "status": "started" | "completed" | "failed" | "resumed" | "resumed (stopping)" | "stopped", "reason"?: string, "requester": "cron" | "user:<id>", "snapshot"?: { "id": string, "name"?: string, "cloneId"?: string, "file"?: string, } "timestamp": number, "test"?: boolean }

[jedelman8]

Just for kicks, worth exploring the roadmap of webhooks in IPF too. For example, being able to template the JSON body as in Nautobot make it very flexible! :)

https://nautobot.readthedocs.io/en/latest/models/extras/webhook/#jinja2-template-support

https://blog.networktocode.com/post/nautobot-webhooks/

[ghost]

At this time changes to IP Fabric webhooks is not on the roadmap as our highest priorities is adding new vendor functionality.