Webhook

API Authorization

Before you can make requests to this resource, you must have a valid bearer token. Review our API authorization guide to learn how to generate a token. Here's a curl example of how to define your access token in a header:

curl -L "https://webhook.api.korewireless.com/v1/secrets" -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" 

The examples below do not show the required Authorization header due to a bug. We're working on fixing that. In the meantime, be sure to include that in all of your requests.

Create a new secret

post

Creates a new secret with associated metadata.

Authorizations

Header parameters

AuthorizationstringOptional

AcceptstringOptional

Content-TypestringOptional

Body

NamestringRequired

A user-friendly name for the secret.

Responses

post

HTTPcURLJavaScriptPython

POST /v1/secrets HTTP/1.1
Host: webhook.api.korewireless.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "Name": "text"
}

{
  "secret": "text",
  "id": "whs_01jf8c4889ehtbzt0n9mzk1prc",
  "name": "my new secret",
  "status": "active",
  "last_modified": "2025-04-26T14:25:39.863Z"
}

Retrieve a list of secrets

get

Retrieves a list of secrets, optionally filtered by status.

Authorizations

Query parameters

statusstring · enumOptional

Filter secrets by their status.

Example: activePossible values:

page_numberintegerOptional

Optional Filter that indicates the current pagination index of the response.

Example: 1

page_sizeintegerOptional

Optional Filter that indicates the total number of records included in the response.

Example: 10

Header parameters

AuthorizationstringOptional

AcceptstringOptional

Content-TypestringOptional

Responses

get

HTTPcURLJavaScriptPython

GET /v1/secrets HTTP/1.1
Host: webhook.api.korewireless.com
Accept: */*

{
  "data": [
    {
      "id": "whs_01jf8c4889ehtbzt0n9mzk1prc",
      "name": "my new secret",
      "status": "active",
      "last_modified": "2025-04-26T14:25:39.863Z"
    }
  ],
  "meta_data": {
    "count": 1,
    "page_size": 10,
    "page_number": 1,
    "previous_page_url": "https://webhook.api.korewireless.com/v1/secrets?page_size=1&page_number=2",
    "next_page_url": "https://webhook.api.korewireless.com/v1/secrets?page_size=1&page_number=4"
  }
}

Modify an existing secret

patch

Updates the details of an existing secret specified by id.

Authorizations

Path parameters

idstringRequired

The unique identifier of the secret to be updated.

Header parameters

AuthorizationstringOptional

AcceptstringOptional

Content-TypestringOptional

Body

NamestringOptional

A user-friendly name for the secret.

Statusstring · enumOptional

The status of the secret.

Possible values:

Responses

patch

HTTPcURLJavaScriptPython

PATCH /v1/secrets/{id} HTTP/1.1
Host: webhook.api.korewireless.com
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "Name": "text",
  "Status": "active"
}

{
  "id": "whs_01jf8c4889ehtbzt0n9mzk1prc",
  "name": "my new secret",
  "status": "active",
  "last_modified": "2025-04-26T14:25:39.863Z"
}