Download the PHP package pju/kirby-webhook-field without Composer

On this page you can find all versions of the php package pju/kirby-webhook-field. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package kirby-webhook-field

Kirby Webhook Field

This plugin provides a panel field for Kirby CMS. Use it to easily trigger webhooks from the Kirby panel.
Probably the most common use case for a webhook would be to trigger a build or deploy mechanism.

Why use this

If you have a static site that is run by Kirby, you will want to have a mechanism where editors can trigger a new build/deploy and see the current status of the site. This is probably the most common use case for triggering a webhook from inside your CMS. You could also use it to communicate with Zapier, IFTTT, an email app or other services though. Basically any time you want to trigger an outside service that is implemented with a webhook and you want to see the result in the panel, you can use this plugin.

You can even use it just to access any API and to with the data whatever you want, but then you need to manually take care of the state of the panel field.

Installation

Manual

Just download this repo and put the content into /site/plugins/webhook-field.

As git submodule

Run git submodule add https://github.com/pju-/kirby-webhook-field site/plugins/webhook-field in the root of your Kirby installation.

With composer

Run composer require pju/kirby-webhook-field in the root of your Kirby installation.

Next Steps

Quickstart guide.

If you want to quickly set up a deploy hook, check the quickstart guide.

Full options guide.

Check out all the options if you have a more advanced setup or want to learn more about the possibilities the plugin offers.

Caveats

Name Change

This plugin used to be called kirby-webhooks when it was still in beta. After release, I realized that there is now another plugin that provides a different approach to webhook integration. To avoid confusion and make the difference more clear, I have renamed this to kirby-webhook-field. If you have installed the old version: you will have to rename your field type from webhooks to webhook and change your config from pju.webhooks.SETTING to pju.webhook-field.SETTING if you update to the new version.

Is this ready for production?

I run it on several live sites. For you typical use case you should be able to use it without hesitation. There are some corner cases that I am aware of where behaviour is not ideal. At the moment these concern sites with a large amount of pages or with multiple languages. For these the implementation of the "last modified" date is not ideal. You should disable the "outdated" option for those sites. You can comment on this ticket if you want to see progress there more quickly.

Can I use this to communicate with an API?

You can certainly use it to send data to an API. You will have access to the result of your API call via the callback option. However, if your API call does not result in a subsequent incoming call to the status endpoint, you will have to take care of setting the new status yourself. If you need this right now, let me know in this ticket or create your own.

Is this safe?

Incoming request to the status endpoint provided by the plugin will only change the state of the field. Invalid states are discarded. However, I would still recommend setting the name of the endpoint to something safe. You can treat the name almost like an API token.

All versions of kirby-webhook-field with dependencies

PHP Build Version
Package Version
Requires getkirby/composer-installer Version ^1.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package pju/kirby-webhook-field contains the following files

Loading the files please wait ....