Create AWS Webhook configuration
API to create AWS webhook configuration
Path Parameters
- accountId int64 required
Cloud Rewind account ID.
- projectId string required
Cloud Rewind project ID.
- cloudAssemblyId int64 required
AWS cloud assembly ID.
- application/json
Request Body required
- webhookType string required
Possible values: [
pre-protection
,post-protection
,post-recovery
,pre-recovery
,post-reset
,pre-reset
]Type of the webhook.
Value Description pre-protection The webhook will trigger before the protection process initiate. post-protection The webhook will trigger after the protection process completed. pre-recovery The webhook will be triggered before the recovery process. post-recovery The webhook will be triggered after the recovery process is complete. pre-reset The webhook will be triggered before the reset process. post-reset The webhook will be triggered after the reset process is complete. - url string required
URL to which the webhook will send notifications.
This URL must be a valid endpoint that can receive HTTPs requests.
Example:https://example.com/webhook
- retryAttempts int32 required
Possible values:
>= 3
and<= 10
Number of retry attempts for the webhook
- timeout int32 required
Possible values:
<= 3600
Timeout duration in seconds for the webhook request
- 201
- 401
- 403
- 404
- 409
- 412
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
- accountId int64
Cloud Rewind account ID.
- projectId string
Cloud Rewind project ID.
- cloudAssemblyId int64
Unique identifier for the AWS Cloud Assembly
- webhookType string
Type of the webhook.
- url string
Endpoint URL to which the webhook will send requests
- retryAttempts int32
Number of retry attempts in case of failure
- timeout int32
Timeout duration (in seconds) for webhook requests
- lastUpdated date-time
The time when the Webhook config was updated
{
"accountId": 0,
"projectId": "string",
"cloudAssemblyId": 0,
"webhookType": "string",
"url": "string",
"retryAttempts": 0,
"timeout": 0,
"lastUpdated": "2025-08-28"
}
Unauthorized
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}
Forbidden
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}
Not Found
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}
Conflict
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}
Precondition Failed
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}
Internal Server Error
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}