Get a webhook endpoint

GET

/webhook-endpoints/{id}

const url = 'https://api.paywithnablr.com/v1/webhook-endpoints/whe_01M3XX9QZ6J4B1M2N3P4Q5R6S7';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.paywithnablr.com/v1/webhook-endpoints/whe_01M3XX9QZ6J4B1M2N3P4Q5R6S7 \
  --header 'Authorization: Bearer <token>'

Authorizations

secretKey

Parameters

Path Parameters

required

string

/^whe_[0-9A-Z]{26}$/

Example

whe_01M3XX9QZ6J4B1M2N3P4Q5R6S7

Responses

200

The endpoint.

application/json

object

data

required

object

required

string

object

required

string

Allowed value: webhook_endpoint

url

required

string

events

required

Array<string>

Allowed values: payment.succeeded payment.failed payment.abandoned payment.refunded payment_link.paid settlement.paid

active

required

boolean

mode

required

string

Allowed values: test live

secret_last4

required

The end of the signing secret, to tell secrets apart.

string

previous_secret_last4

required

After a roll with an overlap, the end of the old secret, which still signs deliveries until previous_secret_expires_at. null otherwise.

string | null

previous_secret_expires_at

required

When the old secret stops signing. null when only one secret signs.

string | null format: date-time

created_at

required

string format: date-time

updated_at

required

string format: date-time

meta

required

object

request_id

required

This request’s id, also in the X-Request-Id header.

string

Example

{
  "data": {
    "id": "whe_01M3XX9QZ6J4B1M2N3P4Q5R6S7",
    "object": "webhook_endpoint",
    "url": "https://shop.example/webhooks/nablr",
    "events": [
      "payment.succeeded"
    ],
    "mode": "test",
    "secret_last4": "K1q4",
    "previous_secret_last4": null
  }
}

401

UNAUTHENTICATED: no Authorization: Bearer header. The message says what to send: your secret key (Bearer sk_test_… or sk_live_…). INVALID_API_KEY: the key is unknown, malformed or revoked.

application/json

object

error

required

object

message

required

A sentence for a person. Safe to show to your user.

string

code

required

string

Allowed values: VALIDATION_FAILED MALFORMED_REQUEST UNAUTHENTICATED INVALID_API_KEY SECRET_KEY_REQUIRED LIVE_MODE_NOT_ENABLED ACCOUNT_RESTRICTED TEST_MODE_ONLY NOT_FOUND METHOD_NOT_ALLOWED CONFLICT DUPLICATE_REFERENCE IDEMPOTENCY_KEY_REUSED REQUEST_IN_PROGRESS INVALID_STATE_TRANSITION PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE RATE_LIMITED INTERNAL_ERROR SERVICE_UNAVAILABLE

title

required

The code in words, for example Validation failed.

string

reference

A quotable reference for some failures.

string

details

One entry per field that is wrong.

Array<object>

object

field

required

string

code

required

For example required, invalid, format, length, unknown, type.

string

message

required

string

meta

Extra context, such as retry_after_seconds on RATE_LIMITED.

object

key

additional properties

any

meta

required

object

request_id

required

This request’s id, also in the X-Request-Id header.

string

Example

{
  "error": {
    "message": "The API key provided is not valid.",
    "code": "INVALID_API_KEY",
    "title": "Invalid API key"
  },
  "meta": {
    "request_id": "01a0fbd4-3b68-75e0-bd33-0b950ddc99a5"
  }
}

403

SECRET_KEY_REQUIRED: you sent a publishable key. LIVE_MODE_NOT_ENABLED: a live key before your business is verified. ACCOUNT_RESTRICTED: the account is suspended.

application/json

object

error

required

object

message

required

A sentence for a person. Safe to show to your user.

string

code

required

string

title

required

The code in words, for example Validation failed.

string

reference

A quotable reference for some failures.

string

details

One entry per field that is wrong.

Array<object>

object

field

required

string

code

required

For example required, invalid, format, length, unknown, type.

string

message

required

string

meta

Extra context, such as retry_after_seconds on RATE_LIMITED.

object

key

additional properties

any

meta

required

object

request_id

required

This request’s id, also in the X-Request-Id header.

string

Example

{
  "error": {
    "message": "This request needs your secret key. Publishable keys can only be used from a checkout.",
    "code": "SECRET_KEY_REQUIRED",
    "title": "Secret key required"
  },
  "meta": {
    "request_id": "01a0fbd4-3b68-75e0-bd33-0b950ddc99a5"
  }
}

404

NOT_FOUND: no such object in this mode, or it is not yours.

application/json

object

error

required

object

message

required

A sentence for a person. Safe to show to your user.

string

code

required

string

title

required

The code in words, for example Validation failed.

string

reference

A quotable reference for some failures.

string

details

One entry per field that is wrong.

Array<object>

object

field

required

string

code

required

For example required, invalid, format, length, unknown, type.

string

message

required

string

meta

Extra context, such as retry_after_seconds on RATE_LIMITED.

object

key

additional properties

any

meta

required

object

request_id

required

This request’s id, also in the X-Request-Id header.

string

Example

{
  "error": {
    "message": "This payment could not be found.",
    "code": "NOT_FOUND",
    "title": "Not found"
  },
  "meta": {
    "request_id": "01a0fbd4-5df3-7308-8497-51f8ed8d7c77"
  }
}

429

RATE_LIMITED: wait Retry-After seconds, then retry.

application/json

object

error

required

object

message

required

A sentence for a person. Safe to show to your user.

string

code

required

string

title

required

The code in words, for example Validation failed.

string

reference

A quotable reference for some failures.

string

details

One entry per field that is wrong.

Array<object>

object

field

required

string

code

required

For example required, invalid, format, length, unknown, type.

string

message

required

string

meta

Extra context, such as retry_after_seconds on RATE_LIMITED.

object

key

additional properties

any

meta

required

object

request_id

required

This request’s id, also in the X-Request-Id header.

string

Example

{
  "error": {
    "message": "Too many attempts. Please wait a moment and try again.",
    "code": "RATE_LIMITED",
    "title": "Rate limited",
    "meta": {
      "retry_after_seconds": 12
    }
  },
  "meta": {
    "request_id": "01a0fbd4-3b68-75e0-bd33-0b950ddc99a5"
  }
}

Headers

Retry-After

integer

Seconds to wait.

X-RateLimit-Reset

integer

Unix time when a request will be allowed again.