Outgoing Webhooks

Updates an outgoing webhook.

At least one of the following parameters must be included in the request body:

  • name must be unique for each outgoing webhook.
  • description
  • outgoingURLs must be unique for each outgoing webhook, and should be a valid HTTPS address.
  • callThrottling should be higher than 0 and lower than the max value for the account plan.
  • enabled can be set to true or false to configure statuses of all events related to this webhook.
patch/v4/outgoingWebhooks/{webhookId}

Request

  • Base URL: https://demo.caspio.com/integrations/rest
  • URL: https://demo.caspio.com/integrations/rest/v4/outgoingWebhooks/{webhookId}
  • Auth: API key in header Authorization

Path parameters

webhookIdstring required

The webhook identifier (6-character alphanumeric code).

Query parameters

echoboolean

When true, returns the updated webhook in the response. Default: false.

Request body

namestring nullable
descriptionstring nullable
outgoingUrlsstring[] nullable
callThrottlinginteger nullable
enabledboolean nullable

Response

OK

webhookIdstring nullable
namestring nullable
statusstring nullable
descriptionstring nullable
outgoingUrlsstring[] nullable
callThrottlinginteger
secretstring nullable

Only present on creation — the only time the secret is visible

eventCountinteger nullable

Only present on GET single response

messageCountinteger nullable

Only present on GET single response

callCountinteger nullable

Only present on GET single response

errorCountinteger nullable

Only present on GET single response

lastModifiedstring date-time nullable
modifiedBystring nullable
dateCreatedstring date-time
createdBystring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.