Webhooks

Operações

GET/v1/apps/{app_id}/webhooksPOST/v1/apps/{app_id}/webhooksGET/v1/apps/{app_id}/webhooks/{id}DELETE/v1/apps/{app_id}/webhooks/{id}PATCH/v1/apps/{app_id}/webhooks/{id}

---

List webhooks for an app

GET

/v1/apps/{app_id}/webhooks

Lists every webhook endpoint configured for the App. The signing secret is not returned by this route.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

ou

RESTKeyAuth

App REST key (rk_...). Server-to-server calls.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Respostas

OK

Content-Type

application/json

[

  

{

  

  

"app_id": "string",

  

  

"created_at": "string",

  

  

"id": "string",

  

  

"url": "string"

  

}

]

GET

/v1/apps/{app_id}/webhooks

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

Exemplos

---

Create a webhook

POST

/v1/apps/{app_id}/webhooks

Registers a webhook endpoint URL for the App and returns its signing secret exactly once.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

ou

RESTKeyAuth

App REST key (rk_...). Server-to-server calls.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Corpo da Requisição

application/json

{

  

"url": "string"

}

Respostas

Created

Content-Type

application/json

{

  

"app_id": "string",

  

"created_at": "string",

  

"id": "string",

  

"secret": "string",

  

"url": "string"

}

POST

/v1/apps/{app_id}/webhooks

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

Corpo

Exemplos

---

Get a webhook

GET

/v1/apps/{app_id}/webhooks/{id}

Fetches a single webhook config by ID, scoped to the App. The signing secret is not returned by this route.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

ou

RESTKeyAuth

App REST key (rk_...). Server-to-server calls.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

id*

Webhook ID

Tipo

string

Obrigatório

Respostas

OK

Content-Type

application/json

{

  

"app_id": "string",

  

"created_at": "string",

  

"id": "string",

  

"url": "string"

}

GET

/v1/apps/{app_id}/webhooks/{id}

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

id*

Exemplos

---

Delete a webhook

DELETE

/v1/apps/{app_id}/webhooks/{id}

Deletes a webhook config by ID, scoped to the App.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

ou

RESTKeyAuth

App REST key (rk_...). Server-to-server calls.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

id*

Webhook ID

Tipo

string

Obrigatório

Respostas

No Content

DELETE

/v1/apps/{app_id}/webhooks/{id}

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

id*

Exemplos

---

Update a webhook

PATCH

/v1/apps/{app_id}/webhooks/{id}

Updates a webhook's target URL.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

ou

RESTKeyAuth

App REST key (rk_...). Server-to-server calls.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

id*

Webhook ID

Tipo

string

Obrigatório

Corpo da Requisição

application/json

{

  

"url": "string"

}

Respostas

OK

Content-Type

application/json

{

  

"app_id": "string",

  

"created_at": "string",

  

"id": "string",

  

"url": "string"

}

PATCH

/v1/apps/{app_id}/webhooks/{id}

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

id*

Corpo

Exemplos

---

Desenvolvido por VitePress OpenAPI