POST
/
v1
/
apps
/
{app_id}
/
deploys
/
webhook
Create Deploy Webhook
curl --request POST \
  --url https://api.vertracloud.app/v1/apps/{app_id}/deploys/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "owner": "<string>",
  "repo_name": "<string>",
  "repo_id": "<string>",
  "account_id": "<string>"
}'
{
  "status": "success",
  "response": "https://api.vertracloud.app/v1/apps/123/deploys/receiver/webhook"
}
​
app_id
string
required
The ID of the application where the webhook will be created.
​
owner
string
required
The GitHub repository owner.
​
repo_name
string
required
The name of the GitHub repository.
​
repo_id
string
required
The ID of the GitHub repository.
​
account_id
string
required
The GitHub account ID.

​
Response

​
status
string
Indicates if the request was successful. Returns success if the webhook was created successfully.
​
response
string
The URL of the created webhook.
{
  "status": "success",
  "response": "https://api.vertracloud.app/v1/apps/123/deploys/receiver/webhook"
}

​
Error Responses

​
status
string
Returns error if the request fails.
​
code
string
Possible error codes:
  • UNAUTHORIZED: User is not authenticated or lacks permissions.
  • PLAN_RESTRICTED_FEATURE: User plan does not support auto-deploy.
  • INVALID_ACCOUNT_ID: Provided GitHub account ID is invalid.
  • MISSING_REPO_INFORMATION: Required repository information is missing.
  • INSTALLATION_NOT_FOUND: GitHub installation not found for the user.
{
  "status": "error",
  "code": "INVALID_ACCOUNT_ID"
}