Webhooks

Operations

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.

Authorizations

SessionAuth

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

Type

API Key (cookie: notti_session)

or

RESTKeyAuth

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

Type

HTTP (bearer)

Parameters

Path Parameters

app_id*

App ID

Type

string

Required

Responses

OK

Content-Type

application/json

[

  

{

  

  

"app_id": "string",

  

  

"created_at": "string",

  

  

"id": "string",

  

  

"url": "string"

  

}

]

GET

/v1/apps/{app_id}/webhooks

Playground

Authorization

SessionAuth

Variables

Key

Value

app_id*

Samples

---

Create a webhook

POST

/v1/apps/{app_id}/webhooks

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

Authorizations

SessionAuth

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

Type

API Key (cookie: notti_session)

or

RESTKeyAuth

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

Type

HTTP (bearer)

Parameters

Path Parameters

app_id*

App ID

Type

string

Required

Request Body

application/json

{

  

"url": "string"

}

Responses

Created

Content-Type

application/json

{

  

"app_id": "string",

  

"created_at": "string",

  

"id": "string",

  

"secret": "string",

  

"url": "string"

}

POST

/v1/apps/{app_id}/webhooks

Playground

Authorization

SessionAuth

Variables

Key

Value

app_id*

Body

Samples

---

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.

Authorizations

SessionAuth

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

Type

API Key (cookie: notti_session)

or

RESTKeyAuth

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

Type

HTTP (bearer)

Parameters

Path Parameters

app_id*

App ID

Type

string

Required

id*

Webhook ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"app_id": "string",

  

"created_at": "string",

  

"id": "string",

  

"url": "string"

}

GET

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

Playground

Authorization

SessionAuth

Variables

Key

Value

app_id*

id*

Samples

---

Delete a webhook

DELETE

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

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

Authorizations

SessionAuth

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

Type

API Key (cookie: notti_session)

or

RESTKeyAuth

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

Type

HTTP (bearer)

Parameters

Path Parameters

app_id*

App ID

Type

string

Required

id*

Webhook ID

Type

string

Required

Responses

No Content

DELETE

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

Playground

Authorization

SessionAuth

Variables

Key

Value

app_id*

id*

Samples

---

Update a webhook

PATCH

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

Updates a webhook's target URL.

Authorizations

SessionAuth

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

Type

API Key (cookie: notti_session)

or

RESTKeyAuth

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

Type

HTTP (bearer)

Parameters

Path Parameters

app_id*

App ID

Type

string

Required

id*

Webhook ID

Type

string

Required

Request Body

application/json

{

  

"url": "string"

}

Responses

OK

Content-Type

application/json

{

  

"app_id": "string",

  

"created_at": "string",

  

"id": "string",

  

"url": "string"

}

PATCH

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

Playground

Authorization

SessionAuth

Variables

Key

Value

app_id*

id*

Body

Samples

---

Powered by VitePress OpenAPI