List Webhook Secrets

GEThttps://api.omise.co/webhooks/secrets

List all webhook signing secrets for your account. Use this endpoint to view existing secrets, check creation dates, and manage key rotation. Note that the actual secret values are not returned; they are only shown once at creation time.

---

Request Parameters

Optional - 3 fieldsPagination Parameters

▼

`limit`INTEGER(optional)

Number of secrets to return per page.

Example:20

Constraints:Minimum: 1, Maximum: 100, Default: 20

Default:20

`offset`INTEGER(optional)

Number of secrets to skip for pagination. Use with limit to paginate through large result sets.

Example:0

Default:0

`order`STRING(optional)

Sort order of results.

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

---

Responses

200

Successful retrieval

Returns a paginated list of webhook secret objects. Note that the actual secret values are not included in the response for security reasons.

Response includes:

• object - Object type (always "list")
• data - Array of webhook secret objects
• limit - Number of results per page
• offset - Number of skipped results
• total - Total number of secrets
• order - Sort order applied

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Limit exceeds maximum (100)
• Invalid order parameter
• Negative offset value

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/webhooks/secrets \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d limit=20 \
  -d offset=0

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

secrets = Omise::WebhookSecret.list({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

secrets = omise.WebhookSecret.list(
    limit=20,
    offset=0
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const secrets = await omise.webhookSecrets.list({
  limit: 20,
  offset: 0
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$secrets = OmiseWebhookSecret::retrieve(array(
    'limit' => 20,
    'offset' => 0
));

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ScopedList<WebhookSecret> secrets = client.webhookSecrets().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var secrets = await client.WebhookSecrets.GetList(new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

secrets, _ := client.ListWebhookSecrets(&operations.ListWebhookSecrets{
    Limit:  20,
    Offset: 0,
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
authentication_failure	Invalid API key	Verify your secret key is correct
bad_request	Invalid parameters	Check parameter values
invalid_parameters	Invalid pagination parameters	Check limit and offset values

Webhook Secret List Fields

Field	Description
object	Object type (always "list")
data	Array of webhook secret objects
limit	Number of items per page
offset	Number of items skipped
total	Total number of secrets
order	Sort order applied

Webhook Secret Object Fields

Field	Description
object	Object type (always "webhook_secret")
id	Unique secret identifier (whsec_*)
livemode	Whether this is a live mode secret
created_at	ISO 8601 timestamp of creation

---

🔑API Credentials

▼

Try it out

Your IP: ...Loading...