Get a single webhook subscription by ID.

GET

/v1/webhooks/{id}

const url = 'https://api.staging.elasticstage.com/store/v1/webhooks/example';
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.staging.elasticstage.com/store/v1/webhooks/example \
  --header 'Authorization: Bearer <token>'

Authorizations

oauth2
webhooks:read

Parameters

Path Parameters

required

string

Responses

200

Default Response

application/json

object

required

string

events

required

Array<string>

Allowed values: product.available product.unavailable product.inventory_changed product.out_of_stock product.in_stock order.created order.processing order.shipped order.tracking_updated order.delivered order.cancelled order.payment_failed

url

required

string format: uri

status

required

string

Allowed values: active disabled

consecutive_failures

required

integer

<= 9007199254740991

last_delivery_at

required

Any of:

string
null

string format: date-time

last_failure_at

required

Any of:

string
null

string format: date-time

disabled_at

required

Any of:

string
null

string format: date-time

Example

{
  "id": "whk_2d7e9b",
  "events": [
    "order.created",
    "order.tracking_updated"
  ],
  "url": "https://hooks.example.com/elasticstage",
  "status": "active",
  "consecutive_failures": 0,
  "last_delivery_at": null,
  "last_failure_at": null,
  "disabled_at": null
}

401

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "statusCode": 401,
  "code": "UNAUTHORIZED",
  "error": "Unauthorized",
  "message": "Authentication required."
}

403

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "statusCode": 403,
  "code": "FORBIDDEN",
  "error": "Forbidden",
  "message": "Insufficient permissions."
}

404

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "statusCode": 404,
  "code": "NOT_FOUND",
  "error": "Not Found",
  "message": "The requested resource was not found."
}

429

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "error": "Too Many Requests",
  "message": "Rate limit exceeded."
}

500

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "statusCode": 500,
  "code": "INTERNAL_ERROR",
  "error": "Internal Server Error",
  "message": "An unexpected error occurred."
}

503

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "statusCode": 503,
  "code": "SERVICE_UNAVAILABLE",
  "error": "Service Unavailable",
  "message": "The service is temporarily unavailable."
}