Download the PHP package akqa-nz/silverstripe-userforms-webhooks without Composer

On this page you can find all versions of the php package akqa-nz/silverstripe-userforms-webhooks. 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?

Example code of akqa-nz/silverstripe-userforms-webhooks

Informations about the package silverstripe-userforms-webhooks

Silverstripe UserForms Webhooks

Posts Silverstripe UserForms submissions to configurable HTTP webhooks.

Webhook endpoints, headers, default fields, and conditional rules are managed in the CMS. Each fired request is logged against the submission with status code, request body, and response body.

Requirements

For Silverstripe CMS 5, use the 1.x release line (the 1 branch) instead.

Installation

Run dev/build after installing.

CMS usage

  1. Open a User Defined Form (or Elemental user form) in the CMS.
  2. On the Webhooks tab, tick Enable webhooks for this form.
  3. Add one or more webhooks with:
    • Live / Test / Dev endpoint URLs (mapped to SS_ENVIRONMENT_TYPE)
    • Optional HTTP headers
    • Optional default fields (static/templated JSON values)
    • Optional custom rules (same style as email recipient conditions)
  4. On each form field, optionally set Webhook JSON key. When empty, the field Name is converted to lowerCamelCase (e.g. First_Name → firstName). Use dot syntax for nested objects (e.g. customer.firstName) and bracket indexes for arrays (e.g. responses[0].question, responses[1].answer).
  5. Open a submission under Submissions → Webhooks to inspect fired hooks, status codes, and bodies.
  6. Use Trigger on a webhook result row to manually re-fire that webhook. This skips the form-level enable flag and custom rules, posts using the current webhook configuration, and writes a new result row.

Environment-specific endpoints

Each webhook can define different URLs for Silverstripe's three environments:

CMS field Environment (SS_ENVIRONMENT_TYPE)
Live endpoint URL live
Test endpoint URL test
Dev endpoint URL dev

If Dev or Test is left blank, the Live URL is used as a fallback. The webhook will not fire when the resolved URL for the current environment is empty.

Customise resolution with updateResolvedEndpointURL on EditableWebhook:

Default fields, headers, and variables

Each webhook can define default fields that are always merged into the JSON payload, and optional HTTP headers. Field names support dot and bracket syntax. Default field and header values may include variables:

Variable Description
{{ID}} Submitted form ID
{{Created}} Submission created datetime
{{env.NAME}} Value of an allowlisted environment variable named NAME

Environment variables are not available by default. Projects must explicitly allow each name via YAML so secrets such as SS_DATABASE_USERNAME cannot be leaked into webhook payloads or headers:

Only names listed in allowed_env_variables resolve. References to any other env name (for example {{env.SS_DATABASE_PASSWORD}}) are left unchanged.

Examples:

Field name / header Value Result
created {{Created}} "created": "2026-09-14 10:00:00"
submission.referenceId Contact-{{ID}} "submission": { "referenceId": "Contact-123" }
apiKey {{env.MY_WEBHOOK_API_KEY}} "apiKey": "…" (when allowlisted)
Header Authorization Bearer {{env.MY_WEBHOOK_API_KEY}} Authorization: Bearer … (when allowlisted)

Default fields are applied after form submission values, so they are always present on the payload for that webhook.

Example payload

Flat keys:

Nested keys (customer.firstName, customer.lastName, customer.emailAddress) plus defaults:

Array keys (responses[0].question, responses[0].answer, responses[1].question, responses[1].answer):

Extension hooks

Customise request construction from PHP:

Apply extensions via YAML, for example:

Development

All versions of silverstripe-userforms-webhooks with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
guzzlehttp/guzzle Version ^7
silverstripe/framework Version ^5.2
silverstripe/cms Version ^5
silverstripe/userforms Version ^6
symbiote/silverstripe-gridfieldextensions Version ^4
composer/installers Version ^2
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 akqa-nz/silverstripe-userforms-webhooks contains the following files

Loading the files please wait ...