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

​
Overview

Get the current webhook URL and custom field allowlist. When a URL is set, the backend sends a POST to it after each successful incentive lookup (single or batch). If no webhook is configured, url is null.

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_...

Response

Current webhook config

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"]