Outgoing Webhooks

Updates a webhook event.

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

  • type valid values are: table.recordInsert, table.recordUpdate, table.recordDelete.
  • objectId must refer to a table.
  • objectFields applies only to table.recordUpdate, and must be an array of table field names.
  • eventSources is optional and valid values are: Datasheet, DataPages, DataParts, Extensions, RESTAPIs, TriggeredActions, Tasks, DataImports, DataImportTasks.
  • defaultPayloadIncludesSecret is optional and can be set to true or false to include the webhook secret in the event payload.
  • defaultPayloadFields must be an array of table field names.
  • customPayloadTemplate must be a string value using single quotes instead of escaped double quotes in JSON.
  • enabled can be set to true or false.
patch/v4/outgoingWebhooks/{webhookId}/events/{eventId}

Request

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

Path parameters

webhookIdstring required

The webhook identifier (6-character alphanumeric code).

eventIdstring required

The event identifier.

Query parameters

echoboolean

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

Request body

typestring nullable
objectIdstring nullable
objectFieldsstring[] nullable
eventSourcesstring[] nullable
defaultPayloadIncludesSecretboolean nullable
defaultPayloadFieldsstring[] nullable
customPayloadTemplatestring nullable
enabledboolean nullable

Response

OK

eventIdstring nullable
typestring nullable
statusstring nullable
objectNamestring nullable
objectIdstring nullable
objectFieldsstring[] nullable
eventSourcesstring[] nullable
defaultPayloadIncludesSecretboolean nullable
defaultPayloadFieldsstring[] nullable
customPayloadTemplatestring nullable
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.