Stop and remove a webhook (by `id` from list_webhooks).

POST

/datanotes/operations/delete_webhook/

curl --request POST \
  --url https://example.com/datanotes/operations/delete_webhook/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Datanotes-Actor: {"harness":"my-script","model":"","session":"s-1"}' \
  --data '{ "id": "example" }'

Stop and remove a webhook (by id from list_webhooks).

Authorizations

• bearer

Parameters

Header Parameters

X-Datanotes-Actor

string

JSON: on whose behalf the write is made, recorded in the journal (harness, model, session).

Example

{"harness":"my-script","model":"","session":"s-1"}

Request Body^required

Media typeapplication/json

object

id

required

string

Example ^generated

{
  "id": "example"
}

Responses

200

Done.

Media typeapplication/json

object

deleted

required

Always true (an unknown id is a 400).

boolean

Example ^generated

{
  "deleted": true
}

400

Bad input: the body is not a JSON object, or an argument is unknown, missing or of the wrong type.

Media typeapplication/json

object

error

required

What went wrong, for a person or an agent.

string

Example ^generated

{
  "error": "example"
}

401

Missing or wrong bearer token.

Media typeapplication/json

object

error

required

What went wrong, for a person or an agent.

string

Example ^generated

{
  "error": "example"
}

403

A named token beyond its permissions (the engine’s administration, tables outside its write patterns, schema changes without ddl).

Media typeapplication/json

object

error

required

What went wrong, for a person or an agent.

string

Example ^generated

{
  "error": "example"
}

500

Unexpected error.

Media typeapplication/json

object

error

required

What went wrong, for a person or an agent.

string

Example ^generated

{
  "error": "example"
}