Register a webhook

Creates the source and registers the webhook that will feed it. Call it once; the webhook_id it returns is what your systems notify from then on.

POST /api/v2/webhooks

Headers

Same as any authenticated JaaS call — see Authentication. You need x-api-key, x-skt-workspace, x-skt-account and Content-Type: application/json.

Body

webhook.file_mapping

Where to read the file's URL and name from in the notifications you'll send.

Both accept dot and index notation, so you can point at a field nested inside the payload your platform already emits — data.file.url, files[0].url. See Send a notification for how it resolves.

webhook.credentials

How Simetrik authenticates when it downloads the file from your URL.

Omit credentials entirely if your URLs are pre-signed or otherwise public — the file is then fetched with no authentication.

webhook.response_config

What Simetrik answers your systems with. Useful when the platform sending the notification expects a specific acknowledgement.

Example

curl -X POST "$SIMETRIK_INGESTION_URL/api/v2/webhooks" \
  -H "x-api-key: $SIMETRIK_API_KEY" \
  -H "x-skt-workspace: 886" \
  -H "x-skt-account: 23" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Settlement files from the core",
    "webhook": {
      "file_mapping": {
        "url_field": "data.file.url",
        "filename_field": "data.file.name"
      },
      "credentials": {
        "type": "bearer",
        "token": "'"$FILE_SERVER_TOKEN"'"
      },
      "response_config": {
        "status_code": 202,
        "content_type": "application/json",
        "body": {"notification": "accepted"}
      }
    }
  }'

Response

201 Created:

{
  "id": 61171,
  "name": "Settlement files from the core",
  "webhook_id": "61171_wh_9d200105"
}

Errors