Skip to main content
PUT
/
webhook-config
Update webhook configuration
curl --request PUT \
  --url https://api.incentives.leap.energy/alpha/webhook-config \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>",
  "field_names": [
    "<string>"
  ]
}
'
{
  "url": "<string>",
  "field_names": [
    "Project ID",
    "Record ID"
  ]
}

​
Overview

Configure or clear the webhook URL and optional field_names allowlist. Omit fields to leave them unchanged. Use url: null or empty string to clear the webhook. Single lookups can send webhook_custom_fields in POST /incentives; batch items support webhook_custom_fields per item.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Include your Leap API key in the x-api-key header: x-api-key: leap_live_...

Body

application/json

Partial update; all fields optional.

​
url
string<uri> | null

Set webhook URL (HTTPS required). Use null or empty to clear.

​
field_names
string[]

Response

Config updated

Current webhook configuration for the authenticated organization

​
url
string<uri> | null

Webhook URL; POST is sent here after each successful lookup.

​
field_names
string[]
Example:
["Project ID", "Record ID"]