Update a webhook configuration

put

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

configurationId

int64

required

Identifier of the webhook configuration to update

Body Params

Name

string

length between 0 and 255

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

Active

boolean

Indicates if this webhook is active

Authorization

string

length between 0 and 2048

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

Url

string

length between 0 and 2048

Specify the callback URL for webhook subscriptions

PayloadMaxItems

int32

1 to 500

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

PayloadInterval

int32

0 to 3600

Time gap in seconds between successive payloads (max 3600)

Triggers

object

Defines which events trigger webhook notifications and optional filters, keyed by trigger name

RetryHandling

object

Retry configuration for failed webhook deliveries

FieldNamingConvention

string

enum

Naming convention the delivered payload uses for its field names. Accepted values: PASCAL_CASE and CAMEL_CASE

Allowed:

Responses

200Request succeeded

400Malformed request, unknown field, or failed validation

401Authentication missing or rejected

403Authenticated, but the credentials lack the authority this endpoint requires

500Unexpected server error