Update a webhook configuration

put

https://{env}.gainsystems.com/api/v1/webhook/settings/{ConfigurationId}

This was introducd in v2025.10 as part of the new version of multi-webhooks

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

ConfigurationId

string

required

The ID of the specific webhook configuration to update

Body Params

Set up your webhook based on the following parameters

Name

string

Name of this webhook configuration (as this could be one of many)

Active

boolean

Defaults to false

Indicates if this webhook is active

Url

string

Specify the callback URL for webhook subscriptions

Authorization

string

If using Basic authentication, use 'Basic' followed by a Base64 token. In the future, additional authorization methods will be supported.

PayloadMaxItems

integer

≤ 500

Defaults to 100

Maximum number of objects delivered via a single webhook payload (max 500)

PayloadInterval

integer

≤ 3600

Defaults to 60

Time gap in seconds between successive payloads (max 3600)

Triggers

object

Defines which events trigger webhook notifications and optional filters

RetryHandling

object

Retry configuration for failed webhook deliveries

Responses

200

You're webhook configuration has been deleted

400

Double-check your request - you may be missing some query parameters or have provided invalid parameters

401

You are not authenticated to the API

403

You do not have access to this endpoint

404

That route doesn't exist

429

You've exceeded the rate limit

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!