LogoLogo
ProductsDevelopersAPI ReferenceContact Us
API Reference
API Reference
  • Overview
  • Products
    • Super SIM
      • Sim Resource
        • Sim BillingPeriod subresource
      • ESimProfile Resource
      • Fleet Resource
      • NetworkAccessProfile Resource
        • NetworkAccessProfile Network Subresource
      • Network Resource
      • SettingsUpdates Resource
      • Usage Record Resource
      • SMSCommand Resource
      • IPCommand Resource
    • Programmable Wireless
      • Account UsageRecord Resource
      • Command Resource
      • DataSession Resource
      • RatePlan Resource
      • Wireless Sim Resource
      • Sim UsageRecord Resource
  • Global Resources
    • API Clients
      • Ping
      • Clients
    • Identity and Access Management
      • Account
    • Webhook
On this page

Was this helpful?

  1. Global Resources

Webhook

PreviousAccount

Last updated 3 months ago

Was this helpful?

API Authorization

Before you can make requests to this resource, you must have a valid bearer token. Review our API 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.

authorization guide

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
200
A list of secrets
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
405
Method Not Allowed
application/json
500
Internal Server Error
application/json
get
GET /v1/secrets HTTP/1.1
Host: webhook.api.korewireless.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "data": [
    {
      "id": "whs_01jf8c4889ehtbzt0n9mzk1prc",
      "name": "my new secret",
      "status": "active",
      "last_modified": "2025-06-09T13:40:54.604Z"
    }
  ],
  "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"
  }
}
  • API Authorization
  • POSTCreate a new secret
  • GETRetrieve a list of secrets
  • PATCHModify an existing secret

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
201
Secret created successfully
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
405
Method Not Allowed
application/json
500
Internal Server Error
application/json
post
POST /v1/secrets HTTP/1.1
Host: webhook.api.korewireless.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "Name": "text"
}
{
  "secret": "text",
  "id": "whs_01jf8c4889ehtbzt0n9mzk1prc",
  "name": "my new secret",
  "status": "active",
  "last_modified": "2025-06-09T13:40:54.604Z"
}

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
200
Secret updated successfully
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
405
Method Not Allowed
application/json
500
Internal Server Error
application/json
patch
PATCH /v1/secrets/{id} HTTP/1.1
Host: webhook.api.korewireless.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "Name": "text",
  "Status": "active"
}
{
  "id": "whs_01jf8c4889ehtbzt0n9mzk1prc",
  "name": "my new secret",
  "status": "active",
  "last_modified": "2025-06-09T13:40:54.604Z"
}