Webhook json template example?

[YouveGotMeowxy]

Does anybody have one for us not-so-technically-savvy? lol

I tried using several different online XML to JSON converters with the XML example from:

https://phpbu.de/manual/current/en/logging.html#logging.webhook

but they're not working (I get errors). Plus the XML example seems(?) like it doesn't include all possible results (available result vars).

Should I just copy the 'default result body example':

{
  "status": 0,
  "timestamp": 12783781381,
  "duration": 234.3402,
  "backupCount": 1,
  "backupFailed": 0,
  "errorCount": 0,
  "errors": [],
  "backups": [
    {
      "name":
      "status":
      "checks": {
          "executed": 1,
          "failed": 0,
      },
      "crypt": {
          "executed": 1,
          "skipped": 0,
          "failed": 0,
      },
      "syncs" => {
          "executed": 1,
          "skipped": 0,
          "failed": 0
      },
      "cleanup" => {
          "executed": 1,
          "skipped": 0,
          "failed": 0
      }
    }
  ]
}

and hunt down the available matching vars to place on their respective lines? Where can I find that list of all available vars?

thanks in advance! :)

[sebastianfeldmann]

So the web hook works like this.

Put this in your phpbu config file

{
  "type": "webhook",
  "options": {
     "uri": "http://example.com/hook"
   }
}

phpbu will then call your configured uri and send some data to that url.
So you have to setup a URL that phpbu can call and that reads the data and does something with it.

For example you want to write every backup result into your own database somehow.
You can use the webhook to call a script of yours that connects to your database and writes the infos.

If you develop the script on your end you can use the json example from the documentation.

{
  "status": 0,
  "timestamp": 12783781381,
  "duration": 234.3402,
  "backupCount": 1,
  "backupFailed": 0,
  "errorCount": 0,
  "errors": [],
  "backups": [
    {
      "name":
      "status":
      "checks": {
          "executed": 1,
          "failed": 0,
      },
      "crypt": {
          "executed": 1,
          "skipped": 0,
          "failed": 0,
      },
      "syncs" => {
          "executed": 1,
          "skipped": 0,
          "failed": 0
      },
      "cleanup" => {
          "executed": 1,
          "skipped": 0,
          "failed": 0
      }
    }
  ]
}

This is what will be sent to your URL. So you have to program some logic that reads this data and uses it in a way you want to.

[YouveGotMeowxy]

@sebastianfeldmann What are all of the variables available to use though?

for example, the % vars in this:

{
  "tag": "phpbu",
  "title": "phpbu test title",
  "type": "info",
  "body": "Backup done: %status% - %timestamp%"
}

i.e. should I create something that sends this in the body?:

{
  "status": %status% ,
  "timestamp": %timestamp%",
  "duration": %varname?%,
  "backupCount": %varname?%,
  "backupFailed": %varname?%,
  "errorCount": %etc.-for all the rest below as well%,
  "errors": [],
  "backups": [
    {
      "name":
      "status":
      "checks": {
          "executed": 1,
          "failed": 0,
      },
      "crypt": {
          "executed": 1,
          "skipped": 0,
          "failed": 0,
      },
      "syncs" => {
          "executed": 1,
          "skipped": 0,
          "failed": 0
      },
      "cleanup" => {
          "executed": 1,
          "skipped": 0,
          "failed": 0
      }
    }
  ]
}

[sebastianfeldmann]

You have to create something that is able to receive this json body.

The phpbu web hook will call your URL with the json request body.
On your end you can read that body see if a backup failed and then take the appropriate steps.

your web hook pseudo code

// read the http request body
json = http_request_body()

// parse json
info = json_decode( json )

// check if the backups where successful
if ( info.backupFailed > 0 ) 
  // do something appropriate
  alert()

[YouveGotMeowxy]

I hesitate to even write this because a reply at all is unpredictable, but here goes anyway:

I'm still confused as to what %variables% are available to use within the message? I currently get this when sending apprise->gotify

Basically, I'd like the same info sent as the little chart that's shown in the terminal when doing it via cline.

[sebastianfeldmann]

I hesitate to even write this because a reply at all is unpredictable, but here goes anyway:

I'm still confused as of what you are tying to archive.
Could you be so kind to explain the use case of what you want to archive, not your technical problem.
What should be the end goal and what have you tried so far?

[YouveGotMeowxy]

Basically, I'd like the same info sent as the little chart that's shown in the terminal when doing it via cline.

When you run phpbu via cline, when it's all done you get a full status report in a little chart. I want that same report send to my gotify. (which I use apprise to send it to gotify).

As can be seen in the screenshot, not all "%%" variables work (i.e. the "%name%" variable is being sent literally. I'm unable to tell WHICH variables DO work.

I just need to know which ones do work.

[YouveGotMeowxy]

Honestly, if you just created a .json example to use (and added it to your docs) to send to apprise after it's complete, that literally sends all available result info, we can pick and choose from it what we want or don't want sent.

[sebastianfeldmann]

Does this help?

https://github.com/sebastianfeldmann/phpbu/blob/main/doc/config/log/webhook.tpl

[sebastianfeldmann]

Summary Allows:

• status
• timestamp
• duration
• backupCount
• backupFailed
• errorCount

Backup Allows:

• name
• status
• checkCount
• checkFailed
• cryptCount
• cryptFailed
• cryptSkipped
• syncCount
• syncFailed
• syncSkipped
• cleanupCount
• cleanupFailed
• cleanupSkipped

Error Allows:

• class
• message
• file
• line

[YouveGotMeowxy]

Does this help?

https://github.com/sebastianfeldmann/phpbu/blob/main/doc/config/log/webhook.tpl

That's XML 😉

I've been trying to convert to json with no luck. That's how i ran into the problem where the %name% variable is being sent literally rather than expanded to its value.

[sebastianfeldmann]

{
    "status": "%status%",
    "backups": [
        %%backup%%
        {
            "name": "%name%",
            "status": "%status%",
        },
        %%backup%%
    ],
    "errors": [
        %%error%%
        { "class": "%class%" "message":"%message%" "file":"%file%",  "line":"%line%"},
        %%error%%
    ]
}