Replace a webhook configuration

put

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

Replaces the whole configuration. Every secret of the authorization scheme must be sent, and omitting Authorization removes it. Use PATCH to change settings without resending secrets.

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

Whether this configuration delivers webhooks. Omitted means false, on create and on PUT alike: a PUT without Active switches an active configuration off, so send its current value (or use PATCH, which keeps it)

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

length between 0 and 2048

Destination of the webhook: a public HTTP(S) URL without credentials. Required when Active is true. Redirects are not followed.

PayloadMaxItems

int32

1 to 500

Maximum number of records in one payload, 1 to 500 (default 100)

PayloadInterval

int32

0 to 3600

Seconds to wait after a delivered payload before sending the next one, 0 to 3600 (default 60)

Triggers

object

The triggers this configuration delivers, keyed by trigger name, each with Enabled and an optional Filter. A trigger left out is disabled. An active configuration needs at least one enabled trigger. ProductionOrderSubmit requires GAINS X 10.0-ER2610 or later.

RetryHandling

object

How failed deliveries are retried

FieldNamingConvention

string

enum

Naming of the delivered payload's field names: PASCAL_CASE or CAMEL_CASE. Omitted on create, PASCAL_CASE applies; omitted on PUT, the stored value is kept

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