API Reference / Endpoints

Webhook Endpoints

Webhook endpoints receive real-time HTTP notifications about events in your account. Instead of polling the API for changes, configure a URL and EPD will push events to you as they happen.

Quick Start

  1. Create an endpoint with your URL and desired events
  2. Store the signing_secret returned on creation (shown only once)
  3. Verify signatures on incoming webhooks using HMAC-SHA256
  4. Respond with 2xx within 30 seconds to acknowledge receipt

Security

Always verify the EPD-Signature header before processing webhook payloads. See the Webhooks guide section for signature verification details.

POST /webhook_endpoints

Create a webhook endpoint

Creates a new webhook endpoint to receive real-time event notifications. The signing_secret is returned only once in this response — store it securely in your environment variables.

Event Patterns

Subscribe to specific events or use wildcards:

Pattern Matches
* All events
order.* All order events (created, succeeded, failed, refunded, etc.)
subscription.* All subscription events
customer.created Only customer creation events

After Creation

  1. Store the signing_secret — it's shown only once and cannot be retrieved later
  2. Verify signatures on incoming webhooks using HMAC-SHA256
  3. Return 2xx within 30 seconds to acknowledge receipt
  4. Test connectivity with POST /v1/webhook_endpoints/:id/test

Security: Your endpoint URL must use HTTPS. HTTP URLs are rejected.

Header parameters

NameTypeDescription
EPD-Version
string
API version override (format `YYYY-MM-DD`). If omitted, your account's pinned version or the latest version is used.
e.g. "2026-02-11"
X-EPD-Idempotency-Keyrequired
string (uuid)
UUID v4 idempotency key. Same key with same request returns cached response. Keys expire after 24 hours.
e.g. "550e8400-e29b-41d4-a716-446655440000"

Request body required

FieldTypeDescription
urlrequired
string (uri)
The URL that will receive webhook events. Must use HTTPS.
e.g. "https://example.com/webhooks"
description
string
Human-readable description.
e.g. "Production webhook endpoint"
enabled_eventsrequired
array[string]
List of event types to subscribe to. Use `*` for all events, or patterns like `order.*`.
e.g. ["order.*","subscription.created","customer.*"]
api_version
string
Webhook schema version to pin to. If omitted, uses latest.
e.g. "2026-02-10"

Code samples

curl -X POST https://api.epd.com/v1/webhook_endpoints \
  -H "Authorization: Bearer epd_test_sk_xxxx" \
  -H "Content-Type: application/json" \
  -H "EPD-Version: 2026-02-11" \
  -H "X-EPD-Idempotency-Key: $(uuidgen)" \
  -d '{
    "url": "https://example.com/webhooks",
    "description": "Production webhook endpoint",
    "enabled_events": ["order.*", "subscription.*", "customer.*"]
  }'

# IMPORTANT: Save the signing_secret from the response!
const response = await fetch('https://api.epd.com/v1/webhook_endpoints', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer epd_test_sk_xxxx',
    'Content-Type': 'application/json',
    'EPD-Version': '2026-02-11',
    'X-EPD-Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    url: 'https://example.com/webhooks',
    description: 'Production webhook endpoint',
    enabled_events: ['order.*', 'subscription.*', 'customer.*'],
  }),
});

const endpoint = await response.json();

// IMPORTANT: Store this securely — it's shown only once!
console.log(endpoint.signing_secret); // whsec_xxxxxxxxxxxxxxxxxxxx
import uuid
import requests

response = requests.post(
    'https://api.epd.com/v1/webhook_endpoints',
    headers={
        'Authorization': 'Bearer epd_test_sk_xxxx',
        'EPD-Version': '2026-02-11',
        'X-EPD-Idempotency-Key': str(uuid.uuid4()),
    },
    json={
        'url': 'https://example.com/webhooks',
        'description': 'Production webhook endpoint',
        'enabled_events': ['order.*', 'subscription.*', 'customer.*'],
    }
)

endpoint = response.json()
# IMPORTANT: Store this securely — it's shown only once!
print(endpoint['signing_secret'])  # whsec_xxxxxxxxxxxxxxxxxxxx

Responses

201 Webhook endpoint created. **Store the `signing_secret` — it won't be shown again.**
FieldTypeDescription
idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"
urlrequired
string (uri)
e.g. "https://example.com/webhooks"
descriptionnullable
string
e.g. "Production webhook endpoint"
enabled_eventsrequired
array[string]
e.g. ["order.*","subscription.created"]
statusrequired
enum
enableddisabled
e.g. "enabled"
signing_secret
string
Signing secret for verifying webhook signatures. **Only returned on creation.**
e.g. "whsec_xxxxxxxxxxxxxxxxxxxx"
has_pending_rotation
boolean
e.g. false
rotation_expires_atnullable
string (date-time)
created_atrequired
string (date-time)
e.g. "2024-01-15T10:30:00.000Z"
updated_atrequired
string (date-time)
e.g. "2024-01-15T10:30:00.000Z"
api_versionrequired
string
Effective webhook schema version (pinned or latest)
e.g. "2026-02-10"
api_version_pinned_atnullable
string (date-time)
ISO 8601 timestamp when the version was pinned
api_version_deprecatedrequired
boolean
Whether the effective version is deprecated
e.g. false
api_version_sunsetnullable
string
Sunset date (YYYY-MM-DD) for the effective version
400 Bad Request — The request was invalid or cannot be served.
FieldTypeDescription
errorrequired
object
typerequired
enum
The type of error.
invalid_request_errorauthentication_errorauthorization_errorrate_limit_erroridempotency_errorprocessing_errorwebhook_error
coderequired
string
A short string identifying the specific error.
e.g. "validation_error"
messagerequired
string
A human-readable message providing details about the error.
e.g. "Request validation failed"
paramnullable
string
The parameter that caused the error, if applicable.
e.g. "email"
request_id
string
Unique request identifier for debugging.
e.g. "req_a1b2c3d4e5f67890abcdef0123456789"
field_errors
array[object]
Detailed field-level errors for validation failures.
401 Unauthorized — Authentication failed.
FieldTypeDescription
errorrequired
object
typerequired
enum
The type of error.
invalid_request_errorauthentication_errorauthorization_errorrate_limit_erroridempotency_errorprocessing_errorwebhook_error
coderequired
string
A short string identifying the specific error.
e.g. "validation_error"
messagerequired
string
A human-readable message providing details about the error.
e.g. "Request validation failed"
paramnullable
string
The parameter that caused the error, if applicable.
e.g. "email"
request_id
string
Unique request identifier for debugging.
e.g. "req_a1b2c3d4e5f67890abcdef0123456789"
field_errors
array[object]
Detailed field-level errors for validation failures.
GET /webhook_endpoints

List all webhook endpoints

Returns a paginated list. signing_secret is never returned in list responses.

Query parameters

NameTypeDescription
limit
integer
Number of items to return per page.
Default: 10
starting_after
string
Cursor for forward pagination. Returns items created after this ID.
e.g. "550e8400-e29b-41d4-a716-446655440000"
ending_before
string
Cursor for backward pagination. Returns items created before this ID.
e.g. "550e8400-e29b-41d4-a716-446655440001"

Header parameters

NameTypeDescription
EPD-Version
string
API version override (format `YYYY-MM-DD`). If omitted, your account's pinned version or the latest version is used.
e.g. "2026-02-11"

Responses

200 A list of webhook endpoints.
FieldTypeDescription
data
array[WebhookEndpoint]
url
any
e.g. "/v1/webhook_endpoints"
401 Unauthorized — Authentication failed.
FieldTypeDescription
errorrequired
object
typerequired
enum
The type of error.
invalid_request_errorauthentication_errorauthorization_errorrate_limit_erroridempotency_errorprocessing_errorwebhook_error
coderequired
string
A short string identifying the specific error.
e.g. "validation_error"
messagerequired
string
A human-readable message providing details about the error.
e.g. "Request validation failed"
paramnullable
string
The parameter that caused the error, if applicable.
e.g. "email"
request_id
string
Unique request identifier for debugging.
e.g. "req_a1b2c3d4e5f67890abcdef0123456789"
field_errors
array[object]
Detailed field-level errors for validation failures.
GET /webhook_endpoints/{id}

Retrieve a webhook endpoint

signing_secret is never returned.

Path parameters

NameTypeDescription
idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"

Header parameters

NameTypeDescription
EPD-Version
string
API version override (format `YYYY-MM-DD`). If omitted, your account's pinned version or the latest version is used.
e.g. "2026-02-11"

Responses

200 The webhook endpoint.
FieldTypeDescription
idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"
urlrequired
string (uri)
e.g. "https://example.com/webhooks"
descriptionnullable
string
e.g. "Production webhook endpoint"
enabled_eventsrequired
array[string]
e.g. ["order.*","subscription.created"]
statusrequired
enum
enableddisabled
e.g. "enabled"
signing_secret
string
Signing secret for verifying webhook signatures. **Only returned on creation.**
e.g. "whsec_xxxxxxxxxxxxxxxxxxxx"
has_pending_rotation
boolean
e.g. false
rotation_expires_atnullable
string (date-time)
created_atrequired
string (date-time)
e.g. "2024-01-15T10:30:00.000Z"
updated_atrequired
string (date-time)
e.g. "2024-01-15T10:30:00.000Z"
api_versionrequired
string
Effective webhook schema version (pinned or latest)
e.g. "2026-02-10"
api_version_pinned_atnullable
string (date-time)
ISO 8601 timestamp when the version was pinned
api_version_deprecatedrequired
boolean
Whether the effective version is deprecated
e.g. false
api_version_sunsetnullable
string
Sunset date (YYYY-MM-DD) for the effective version
404 Not Found — The requested resource doesn't exist.
FieldTypeDescription
errorrequired
object
typerequired
enum
The type of error.
invalid_request_errorauthentication_errorauthorization_errorrate_limit_erroridempotency_errorprocessing_errorwebhook_error
coderequired
string
A short string identifying the specific error.
e.g. "validation_error"
messagerequired
string
A human-readable message providing details about the error.
e.g. "Request validation failed"
paramnullable
string
The parameter that caused the error, if applicable.
e.g. "email"
request_id
string
Unique request identifier for debugging.
e.g. "req_a1b2c3d4e5f67890abcdef0123456789"
field_errors
array[object]
Detailed field-level errors for validation failures.
PATCH /webhook_endpoints/{id}

Update a webhook endpoint

signing_secret is never returned on update.

Path parameters

NameTypeDescription
idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"

Header parameters

NameTypeDescription
EPD-Version
string
API version override (format `YYYY-MM-DD`). If omitted, your account's pinned version or the latest version is used.
e.g. "2026-02-11"
X-EPD-Idempotency-Keyrequired
string (uuid)
UUID v4 idempotency key. Same key with same request returns cached response. Keys expire after 24 hours.
e.g. "550e8400-e29b-41d4-a716-446655440000"

Request body required

FieldTypeDescription
url
string (uri)
e.g. "https://example.com/webhooks/v2"
description
string
e.g. "Updated production webhook endpoint"
enabled_events
array[string]
e.g. ["order.*","customer.*"]
status
enum
enableddisabled
e.g. "enabled"
api_version
string
Webhook schema version to pin to. If omitted, uses latest.
e.g. "2026-02-10"

Responses

200 The updated webhook endpoint.
FieldTypeDescription
idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"
urlrequired
string (uri)
e.g. "https://example.com/webhooks"
descriptionnullable
string
e.g. "Production webhook endpoint"
enabled_eventsrequired
array[string]
e.g. ["order.*","subscription.created"]
statusrequired
enum
enableddisabled
e.g. "enabled"
signing_secret
string
Signing secret for verifying webhook signatures. **Only returned on creation.**
e.g. "whsec_xxxxxxxxxxxxxxxxxxxx"
has_pending_rotation
boolean
e.g. false
rotation_expires_atnullable
string (date-time)
created_atrequired
string (date-time)
e.g. "2024-01-15T10:30:00.000Z"
updated_atrequired
string (date-time)
e.g. "2024-01-15T10:30:00.000Z"
api_versionrequired
string
Effective webhook schema version (pinned or latest)
e.g. "2026-02-10"
api_version_pinned_atnullable
string (date-time)
ISO 8601 timestamp when the version was pinned
api_version_deprecatedrequired
boolean
Whether the effective version is deprecated
e.g. false
api_version_sunsetnullable
string
Sunset date (YYYY-MM-DD) for the effective version
400 Bad Request — The request was invalid or cannot be served.
FieldTypeDescription
errorrequired
object
typerequired
enum
The type of error.
invalid_request_errorauthentication_errorauthorization_errorrate_limit_erroridempotency_errorprocessing_errorwebhook_error
coderequired
string
A short string identifying the specific error.
e.g. "validation_error"
messagerequired
string
A human-readable message providing details about the error.
e.g. "Request validation failed"
paramnullable
string
The parameter that caused the error, if applicable.
e.g. "email"
request_id
string
Unique request identifier for debugging.
e.g. "req_a1b2c3d4e5f67890abcdef0123456789"
field_errors
array[object]
Detailed field-level errors for validation failures.
404 Not Found — The requested resource doesn't exist.
FieldTypeDescription
errorrequired
object
typerequired
enum
The type of error.
invalid_request_errorauthentication_errorauthorization_errorrate_limit_erroridempotency_errorprocessing_errorwebhook_error
coderequired
string
A short string identifying the specific error.
e.g. "validation_error"
messagerequired
string
A human-readable message providing details about the error.
e.g. "Request validation failed"
paramnullable
string
The parameter that caused the error, if applicable.
e.g. "email"
request_id
string
Unique request identifier for debugging.
e.g. "req_a1b2c3d4e5f67890abcdef0123456789"
field_errors
array[object]
Detailed field-level errors for validation failures.
DELETE /webhook_endpoints/{id}

Delete a webhook endpoint

Path parameters

NameTypeDescription
idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"

Header parameters

NameTypeDescription
EPD-Version
string
API version override (format `YYYY-MM-DD`). If omitted, your account's pinned version or the latest version is used.
e.g. "2026-02-11"

Responses

200 Webhook endpoint deleted.
FieldTypeDescription
idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"
deletedrequired
true
messagerequired
string
e.g. "Webhook endpoint successfully deleted."
404 Not Found — The requested resource doesn't exist.
FieldTypeDescription
errorrequired
object
typerequired
enum
The type of error.
invalid_request_errorauthentication_errorauthorization_errorrate_limit_erroridempotency_errorprocessing_errorwebhook_error
coderequired
string
A short string identifying the specific error.
e.g. "validation_error"
messagerequired
string
A human-readable message providing details about the error.
e.g. "Request validation failed"
paramnullable
string
The parameter that caused the error, if applicable.
e.g. "email"
request_id
string
Unique request identifier for debugging.
e.g. "req_a1b2c3d4e5f67890abcdef0123456789"
field_errors
array[object]
Detailed field-level errors for validation failures.
POST /webhook_endpoints/{id}/rotate_secret

Rotate signing secret

Generates a new signing secret for the webhook endpoint. During the grace period, both the old and new secrets are valid — giving you time to update your verification code without dropping events.

Rotation Flow

  1. Call this endpoint → receive new_signing_secret
  2. Deploy your updated verification code (accept both old and new secrets)
  3. After the grace period expires, only the new secret works

Grace Period

Value Use Case
1 hour Quick rotation, single-server deployments
24 hours (default) Standard rotation, multi-server deployments
72 hours Large deployments with rolling updates

Security: Rotate secrets periodically or immediately if you suspect a secret has been compromised.

Path parameters

NameTypeDescription
idrequired
string
Webhook endpoint ID (UUID).
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"

Header parameters

NameTypeDescription
EPD-Version
string
API version override (format `YYYY-MM-DD`). If omitted, your account's pinned version or the latest version is used.
e.g. "2026-02-11"
X-EPD-Idempotency-Keyrequired
string (uuid)
UUID v4 idempotency key. Same key with same request returns cached response. Keys expire after 24 hours.
e.g. "550e8400-e29b-41d4-a716-446655440000"

Request body

FieldTypeDescription
grace_period_hours
integer
Hours both the old and new secrets are valid.
e.g. 24

Code samples

curl -X POST https://api.epd.com/v1/webhook_endpoints/6ba7b817-9dad-11d1-80b4-00c04fd430c8/rotate_secret \
  -H "Authorization: Bearer epd_test_sk_xxxx" \
  -H "Content-Type: application/json" \
  -H "EPD-Version: 2026-02-11" \
  -H "X-EPD-Idempotency-Key: $(uuidgen)" \
  -d '{ "grace_period_hours": 24 }'
const response = await fetch(
  'https://api.epd.com/v1/webhook_endpoints/6ba7b817-9dad-11d1-80b4-00c04fd430c8/rotate_secret',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer epd_test_sk_xxxx',
      'Content-Type': 'application/json',
      'EPD-Version': '2026-02-11',
      'X-EPD-Idempotency-Key': crypto.randomUUID(),
    },
    body: JSON.stringify({ grace_period_hours: 24 }),
  }
);

const result = await response.json();
// Deploy this new secret to your webhook handler
console.log(result.new_signing_secret);
console.log(result.previous_secret_valid_until); // Unix timestamp

Responses

200 Secret rotated. Store the new secret securely.
FieldTypeDescription
idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"
new_signing_secretrequired
string
e.g. "whsec_new_xxxxxxxxxxxx"
previous_secret_valid_untilrequired
string (date-time)
ISO 8601 timestamp when the old secret stops working.
e.g. "2024-01-16T10:30:00.000Z"
messagerequired
string
e.g. "New secret active. Previous secret valid for 24 hours."
404 Not Found — The requested resource doesn't exist.
FieldTypeDescription
errorrequired
object
typerequired
enum
The type of error.
invalid_request_errorauthentication_errorauthorization_errorrate_limit_erroridempotency_errorprocessing_errorwebhook_error
coderequired
string
A short string identifying the specific error.
e.g. "validation_error"
messagerequired
string
A human-readable message providing details about the error.
e.g. "Request validation failed"
paramnullable
string
The parameter that caused the error, if applicable.
e.g. "email"
request_id
string
Unique request identifier for debugging.
e.g. "req_a1b2c3d4e5f67890abcdef0123456789"
field_errors
array[object]
Detailed field-level errors for validation failures.
POST /webhook_endpoints/{id}/test

Send a test event

Sends a test webhook event to the endpoint to verify connectivity.

Path parameters

NameTypeDescription
idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"

Header parameters

NameTypeDescription
EPD-Version
string
API version override (format `YYYY-MM-DD`). If omitted, your account's pinned version or the latest version is used.
e.g. "2026-02-11"

Request body

FieldTypeDescription
event_type
string
Event type to simulate.
e.g. "order.succeeded"
api_version
string
Webhook schema version for the test payload.
e.g. "2026-02-10"

Responses

200 Test result.
FieldTypeDescription
idrequired
string
e.g. "wht_123"
endpoint_idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430d0"
statusrequired
enum
successfailed
e.g. "success"
http_status_codenullable
integer
e.g. 200
response_time_msnullable
integer
e.g. 150
error_messagenullable
string
sent_atrequired
string (date-time)
e.g. "2024-01-15T10:30:00.000Z"
404 Not Found — The requested resource doesn't exist.
FieldTypeDescription
errorrequired
object
typerequired
enum
The type of error.
invalid_request_errorauthentication_errorauthorization_errorrate_limit_erroridempotency_errorprocessing_errorwebhook_error
coderequired
string
A short string identifying the specific error.
e.g. "validation_error"
messagerequired
string
A human-readable message providing details about the error.
e.g. "Request validation failed"
paramnullable
string
The parameter that caused the error, if applicable.
e.g. "email"
request_id
string
Unique request identifier for debugging.
e.g. "req_a1b2c3d4e5f67890abcdef0123456789"
field_errors
array[object]
Detailed field-level errors for validation failures.
GET /webhook_endpoints/{id}/events

List webhook events

Returns events sent to a specific webhook endpoint.

Path parameters

NameTypeDescription
idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"

Query parameters

NameTypeDescription
limit
integer
Number of items to return per page.
Default: 10
starting_after
string
Cursor for forward pagination. Returns items created after this ID.
e.g. "550e8400-e29b-41d4-a716-446655440000"
status
string
Filter: `pending`, `processing`, `delivered`, `failed`, `dead_letter`.
e.g. "delivered"

Header parameters

NameTypeDescription
EPD-Version
string
API version override (format `YYYY-MM-DD`). If omitted, your account's pinned version or the latest version is used.
e.g. "2026-02-11"

Responses

200 A list of webhook events.
FieldTypeDescription
data
array[object]
404 Not Found — The requested resource doesn't exist.
FieldTypeDescription
errorrequired
object
typerequired
enum
The type of error.
invalid_request_errorauthentication_errorauthorization_errorrate_limit_erroridempotency_errorprocessing_errorwebhook_error
coderequired
string
A short string identifying the specific error.
e.g. "validation_error"
messagerequired
string
A human-readable message providing details about the error.
e.g. "Request validation failed"
paramnullable
string
The parameter that caused the error, if applicable.
e.g. "email"
request_id
string
Unique request identifier for debugging.
e.g. "req_a1b2c3d4e5f67890abcdef0123456789"
field_errors
array[object]
Detailed field-level errors for validation failures.
GET /webhook_endpoints/{id}/delivery_logs

List delivery logs

Returns delivery attempt logs for a specific webhook endpoint.

Path parameters

NameTypeDescription
idrequired
string
e.g. "6ba7b817-9dad-11d1-80b4-00c04fd430c8"

Query parameters

NameTypeDescription
limit
integer
Number of items to return per page.
Default: 10
starting_after
string
Cursor for forward pagination. Returns items created after this ID.
e.g. "550e8400-e29b-41d4-a716-446655440000"

Header parameters

NameTypeDescription
EPD-Version
string
API version override (format `YYYY-MM-DD`). If omitted, your account's pinned version or the latest version is used.
e.g. "2026-02-11"

Responses

200 A list of delivery logs.
FieldTypeDescription
data
array[object]
404 Not Found — The requested resource doesn't exist.
FieldTypeDescription
errorrequired
object
typerequired
enum
The type of error.
invalid_request_errorauthentication_errorauthorization_errorrate_limit_erroridempotency_errorprocessing_errorwebhook_error
coderequired
string
A short string identifying the specific error.
e.g. "validation_error"
messagerequired
string
A human-readable message providing details about the error.
e.g. "Request validation failed"
paramnullable
string
The parameter that caused the error, if applicable.
e.g. "email"
request_id
string
Unique request identifier for debugging.
e.g. "req_a1b2c3d4e5f67890abcdef0123456789"
field_errors
array[object]
Detailed field-level errors for validation failures.
POST /webhook_endpoints/{id}/upgrade_version

Upgrade endpoint version

Path parameters

NameTypeDescription
idrequired
string

Request body required

FieldTypeDescription
api_versionrequired
string
Target version to upgrade to (must be newer than current).
e.g. "2026-02-10"
confirmrequired
boolean
Must be true to confirm the upgrade.

Responses

200 Version upgraded
FieldTypeDescription
idrequired
string
Endpoint ID
api_versionrequired
string
New version
previous_versionrequired
string
Old version
changed_atrequired
integer
Unix timestamp
messagerequired
string
POST /webhook_endpoints/{id}/downgrade_version

Downgrade endpoint version

Path parameters

NameTypeDescription
idrequired
string

Request body required

FieldTypeDescription
api_versionrequired
string
Target version to downgrade to (must be older than current).
e.g. "2026-02-10"
confirmrequired
boolean
Must be true to confirm the downgrade.

Responses

200 Version downgraded
FieldTypeDescription
idrequired
string
Endpoint ID
api_versionrequired
string
New version
previous_versionrequired
string
Old version
changed_atrequired
integer
Unix timestamp
messagerequired
string
POST /webhook_endpoints/{id}/events/{eventId}/replay

Replay webhook event

Path parameters

NameTypeDescription
idrequired
string
eventIdrequired
string

Request body required

FieldTypeDescription
api_version
string
Version to replay at. Defaults to original event version.
confirmrequired
boolean
Must be true to confirm the replay.

Responses

200 Event replayed
FieldTypeDescription
idrequired
string
New event ID
original_event_idrequired
string
endpoint_idrequired
string
api_versionrequired
string
statusrequired
string
messagerequired
string