Update part of a webhook configuration

patch

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

Changes only the fields sent; everything omitted keeps its stored value, secrets included, so an edit never needs the credentials again. Triggers and RetryHandling are replaced as a whole when present. Authorization is merged: with the same scheme only the fields sent change (a field sent empty is cleared); a different scheme replaces it and needs all its required fields; {} removes it. A body that sets no field is rejected with 400.

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

Name of this webhook configuration. Omit to leave unchanged.

Active

boolean

Whether this webhook is active. Omit to leave unchanged.

Authorization

object

How this webhook authenticates to the destination. Set at most one member; an empty object sends no authorization. A read lists only the configured member, and returns an empty object when there is none. A plain string is also accepted in place of this object, as shorthand for Header with that value. On a PUT, omitting Authorization removes it; on a PATCH, omitting it keeps the stored configuration.

Url

string

Destination of the webhook: a public HTTP(S) URL without credentials. Redirects are not followed. Omit to leave unchanged. Required when the configuration is active once the patch is applied: activating a configuration that has no URL, or clearing the URL of an active one, is refused.

PayloadMaxItems

int32

Maximum number of records in one payload, 1 to 500. Omit to leave unchanged.

PayloadInterval

int32

Seconds to wait after a delivered payload before sending the next one, 0 to 3600. Omit to leave unchanged.

Triggers

object

Replaces every trigger when present, keyed by trigger name; a trigger left out is then disabled. ProductionOrderSubmit requires GAINS X 10.0-ER2610 or later. Omit to leave the triggers unchanged.

RetryHandling

object

How failed deliveries are retried

FieldNamingConvention

string

enum

Naming convention of the delivered payload's fields: PASCAL_CASE or CAMEL_CASE. Omit to leave unchanged.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

200Request succeeded

400Malformed request, unknown field, or failed validation

401Credentials missing or not valid: a wrong user name or password, an invalid or expired token, or Basic credentials on an endpoint that accepts only a Bearer token

403Your credentials do not have the permission this endpoint requires, or the GAINS X connection is not enabled for your environment

404No webhook configuration with that id

426The connected GAINS X version does not support this endpoint. The body states the current version and the version required

500Unexpected server error

503GAINS is temporarily unavailable: GAINS X could not be reached or returned an error, a scheduled GAINS process is running, or your credentials could not be checked. Retry later

504GAINS X did not respond in time. Retry later