> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vertracloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter URL do webhook de deploy

> Retorna a URL do webhook de deploy do GitHub e as informações do repositório de uma aplicação.

**app\_id** `string` *required*

O ID da aplicação cuja URL do webhook será retornada.

### Resposta

**response** `object`

Contém os detalhes do repositório e do webhook.

**Mostrar objeto**

**repo\_owner** `string`

O proprietário do repositório no GitHub.

**repo\_name** `string`

O nome do repositório no GitHub.

**webhook\_url** `string`

A URL do webhook de deploy.

**branch** `string | null`

A branch cujos pushes fazem o deploy da aplicação. `null` significa `main` ou `master`.

```json theme={null}
{
  "response": {
    "repo_owner": "owner_name",
    "repo_name": "repository_name",
    "webhook_url": "https://api.vertracloud.app/v1/apps/123/deploys/receiver/webhook",
    "branch": "develop"
  }
}
```

### Respostas de erro

**code** `string`

Códigos de erro possíveis:

* `AUTH_TOKEN_MISSING`, `API_KEY_INVALID`, `SESSION_REVOKED`: o cabeçalho `Authorization` está ausente, a chave de API é inválida ou a sessão do painel foi revogada (`401`).
* `API_KEY_IP_DENIED`, `API_KEY_SCOPE_DENIED`: a chave de API está sendo usada a partir de um IP fora da sua lista de permissões, ou não tem o escopo que a rota exige (`403`).
* `ACCESS_DENIED`: o recurso pertence a outra conta, ou você não tem a permissão do workspace para ele (`403`).
* `PLAN_RESTRICTED_FEATURE`: o plano do usuário não oferece suporte a deploy automático.
* `DEPLOYMENT_NOT_FOUND`: webhook de integração não encontrado para a aplicação.

**message** `string`

Uma mensagem descritiva com detalhes adicionais sobre o erro.

```json theme={null}
{
  "code": "DEPLOYMENT_NOT_FOUND"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.