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

Authorizationstring

Acceptstring

Content-Typestring

Body

Namestringrequired

A user-friendly name for the secret.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://webhook.api.korewireless.com/v1/secrets' \
  --header 'Content-Type: application/json' \
  --data '{
    "Name": "text"
  }'

201

400

401

403

404

405

500

201

{
  "secret": "text",
  "id": "whs_01jf8c4889ehtbzt0n9mzk1prc",
  "name": "my new secret",
  "status": "active",
  "last_modified": "2025-03-17T10:10:02.603Z"
}

Secret created successfully

Retrieve a list of secrets

get

Retrieves a list of secrets, optionally filtered by status.

Authorizations

Query parameters

statusstring · enum

Filter secrets by their status.

Example: active

Options: active, pending

page_numberinteger

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

Example: 1

page_sizeinteger

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

Example: 10

Header parameters

Authorizationstring

Acceptstring

Content-Typestring

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://webhook.api.korewireless.com/v1/secrets'

200

400

401

403

404

405

500

200

{
  "data": [
    {
      "id": "whs_01jf8c4889ehtbzt0n9mzk1prc",
      "name": "my new secret",
      "status": "active",
      "last_modified": "2025-03-17T10:10:02.603Z"
    }
  ],
  "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"
  }
}

A list of secrets

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

Authorizationstring

Acceptstring

Content-Typestring

Body

Namestring

A user-friendly name for the secret.

Statusstring · enum

The status of the secret.

Options: active, pending

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://webhook.api.korewireless.com/v1/secrets/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "Name": "text",
    "Status": "active"
  }'

200

400

401

403

404

405

500

200

{
  "id": "whs_01jf8c4889ehtbzt0n9mzk1prc",
  "name": "my new secret",
  "status": "active",
  "last_modified": "2025-03-17T10:10:02.603Z"
}

Secret updated successfully