Oracle Commerce Cloud Service - Use the REST API to configure webhooks

Use the REST API to configure webhooks

This section provides an overview of actions you can perform with the Oracle Commerce Cloud Admin API’s Event Webhooks and Function Webhooks endpoints. See Learn about the APIs for information about accessing the endpoint documentation.

The following table describes the endpoints for the Event Webhooks resource.

Endpoint	Description and URI
`getWebHook`	Gets a specified webhook. `GET /ccadmin/v1/webhooks/{id}`
`getWebHooks`	Gets an array of webhooks, which can be narrowed by server type, for example, production. Each element of the returned array follows the format of that returned by `getWebHook`. `GET /ccadmin/v1/webhooks`
`updateWebHook`	Updates the URL properties of a specified webhook and, optionally, resets the secret key. You can use the REST API to change the number of times a webhook gets resent and the number of seconds between resends. `PUT /ccadmin/v1/webhooks/{id}`
`updateWebHooks`	Updates the URL properties of an array of existing webhooks and, optionally, resets the secret keys. You can use the REST API to change the number of times a webhook gets resent and the number of seconds between resends. `PUT /ccadmin/v1/webhooks`
`webhookOperation`	Resets the secret key of a specified webhook. `POST /ccadmin/v1/webhooks/{id}`

The following table describes the endpoints for the Function Webhooks resource.

Endpoint	Description and URI
`getFunctionWebHook`	Gets a specified webhook. `GET /ccadmin/v1/functionWebhooks/{id}`
`getFunctionWebHooks`	Gets an array of webhooks, which can be narrowed by server type, for example, production. Each element of the returned array follows the format of that returned by `getWebHook`. `GET /ccadmin/v1/functionWebhooks`
`updateFunctionWebHook`	Updates the URL properties of a specified webhook and, optionally, resets the secret key. `PUT /ccadmin/v1/functionWebhooks/{id}`
`updateFunctionWebHooks`	Updates the URL properties of an array of existing webhooks and, optionally, resets the secret keys. `PUT /ccadmin/v1/functionWebhooks`
`functionWebhookOperation`	Resets the secret key of a specified webhook. `POST /ccadmin/v1/functionWebhooks/{id}`

The following table describes the endpoints that you can use to manage failed messages. These are described in more detail in the next section.

Endpoint	Description and URI
`deleteFailedMessage`	Deletes a specified webhook message that failed to send. `DELETE /ccadmin/v1/webhookFailedMessages/{id}`
`getFailedMessage`	Gets a specified webhook message that failed to send. `GET /ccadmin/v1/webhookFailedMessages/{id}`
`getFailedMessages`	Gets an array of webhook messages that failed to send. Each element of the returned array follows the format of that returned by `getFailedMessage`. `GET /ccadmin/v1/webhookFailedMessages`
`updateFailedMessage`	Specifies a failed webhook message to resend. `PUT /ccadmin/v1/webhookFailedMessages/{id}`
`updateFailedMessages`	Specifies an array of failed webhook messages to resend. `PUT /ccadmin/v1/webhookFailedMessages`

Copyright © 1997, 2017 Oracle and/or its affiliates. All rights reserved. Legal Notices