Skip to main content
Version: 0.16

WebHook

Defines a webhook endpoint for event notifications.

This object can be configured from the WebUI under Settings › Telemetry › Webhooks

Fields​

allowInvalidCerts​

Type: Boolean · default: false

Whether Stalwart should connect to a webhook endpoint that has an invalid TLS certificate

signatureKey​

Type: SecretKeyOptional · required

The HMAC key used to sign the webhook request body to prevent tampering

throttle​

Type: Duration · default: "1s"

The minimum amount of time that must pass between each request to the webhook endpoint

timeout​

Type: Duration · default: "30s"

Maximum amount of time that Stalwart will wait for a response from this webhook

discardAfter​

Type: Duration · default: "5m"

The duration after which the webhook will be discarded if it cannot be delivered

url​

Type: Uri · required

URL of the webhook endpoint

httpAuth​

Type: HttpAuth · required

The type of HTTP authentication to use

httpHeaders​

Type: Map<String, String>

Additional headers to include in HTTP requests

enable​

Type: Boolean · default: true

Enable or disable the tracer

level​

Type: TracingLevel · default: "info"

The logging level for this tracer

lossy​

Type: Boolean · default: false

Whether to drop log entries if there is backlog

events​

Type: EventType[]

List of events to include or exclude based on filter mode

eventsPolicy​

Type: EventPolicy · default: "exclude"

How to interpret the events list

JMAP API​

The WebHook object is available via the urn:stalwart:jmap capability.

x:WebHook/get​

This is a standard Foo/get method as defined in RFC 8620, Section 5.1.

This method requires the sysWebHookGet permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:WebHook/get",
          {
            "ids": [
              "id1"
            ]
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

x:WebHook/set​

This is a standard Foo/set method as defined in RFC 8620, Section 5.3.

Supports create, update, and destroy operations in a single call.

Create​

This operation requires the sysWebHookCreate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:WebHook/set",
          {
            "create": {
              "new1": {
                "allowInvalidCerts": false,
                "discardAfter": "5m",
                "enable": true,
                "events": [],
                "eventsPolicy": "exclude",
                "httpAuth": {
                  "@type": "Unauthenticated"
                },
                "httpHeaders": {},
                "level": "info",
                "lossy": false,
                "signatureKey": {
                  "@type": "None"
                },
                "throttle": "1s",
                "timeout": "30s",
                "url": "https://example.com"
              }
            }
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

Update​

This operation requires the sysWebHookUpdate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:WebHook/set",
          {
            "update": {
              "id1": {
                "allowInvalidCerts": false
              }
            }
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

Destroy​

This operation requires the sysWebHookDestroy permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:WebHook/set",
          {
            "destroy": [
              "id1"
            ]
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

x:WebHook/query​

This is a standard Foo/query method as defined in RFC 8620, Section 5.5.

This method requires the sysWebHookQuery permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:WebHook/query",
          {
            "filter": {}
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

CLI​

stalwart-cli wraps the same JMAP calls. See the CLI reference for installation, authentication, and general usage.

Fetch​

stalwart-cli get web-hook id1

Create​

stalwart-cli create web-hook \
  --field allowInvalidCerts=false \
  --field 'signatureKey={"@type":"None"}' \
  --field throttle=1s \
  --field timeout=30s \
  --field discardAfter=5m \
  --field url=https://example.com \
  --field 'httpAuth={"@type":"Unauthenticated"}' \
  --field 'httpHeaders={}' \
  --field enable=true \
  --field level=info \
  --field lossy=false \
  --field 'events=[]' \
  --field eventsPolicy=exclude

Query​

stalwart-cli query web-hook

Update​

stalwart-cli update web-hook id1 --field description='Updated'

Delete​

stalwart-cli delete web-hook --ids id1

Nested types​

SecretKeyOptional​

An optional secret value, or none.

  • None: No secret. No additional fields.
  • Value: Secret value. Carries the fields of SecretKeyValue.
  • EnvironmentVariable: Secret read from environment variable. Carries the fields of SecretKeyEnvironmentVariable.
  • File: Secret read from file. Carries the fields of SecretKeyFile.

SecretKeyValue​

A secret value provided directly.

secret​

Type: String · required · secret

Password or secret value

SecretKeyEnvironmentVariable​

A secret value read from an environment variable.

variableName​

Type: String · required

Environment variable name to read the secret from

SecretKeyFile​

A secret value read from a file.

filePath​

Type: String · required

File path to read the secret from

HttpAuth​

Defines the HTTP authentication method to use for HTTP requests.

  • Unauthenticated: Anonymous. No additional fields.
  • Basic: Basic Authentication. Carries the fields of HttpAuthBasic.
  • Bearer: Bearer Token. Carries the fields of HttpAuthBearer.

HttpAuthBasic​

HTTP Basic authentication credentials.

username​

Type: String · required

Username for HTTP Basic Authentication

secret​

Type: SecretKey · required

Password for HTTP Basic Authentication

SecretKey​

A secret value provided directly, from an environment variable, or from a file.

HttpAuthBearer​

HTTP Bearer token authentication.

bearerToken​

Type: SecretKey · required

Bearer token for HTTP Bearer Authentication

Enums​

TracingLevel​

ValueLabel
errorError
warnWarning
infoInfo
debugDebug
traceTrace

EventPolicy​

ValueLabel
includeOnly include the specified events
excludeExclude the specified events