Change an endpoint

PATCH

/v1/webhook-endpoints/{id}

const url = 'https://api.keptslot.com/v1/webhook-endpoints/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"url":"example","events":["booking.created"],"active":true}'
};

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

curl --request PATCH \
  --url https://api.keptslot.com/v1/webhook-endpoints/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example", "events": [ "booking.created" ], "active": true }'

This endpoint changes one webhook endpoint. Send only the fields you want to change. A field you omit keeps its value.

Set active to false to stop deliveries and keep the endpoint.

Authorizations

SecretKey

Parameters

Path Parameters

required

string format: uuid

The webhook endpoint id.

Request Body^required

application/json

object

url

string

events

Array<string>

Allowed values: booking.created booking.cancelled booking.rescheduled booking.no_show payment.succeeded payment.refunded booking.held booking.reminder booking.staff_reminder booking.expired payment.disputed payment.dispute_closed

active

boolean

Responses

200

The endpoint is changed. No secret is in this response.

application/json

object

required

string format: uuid

url

required

string

events

required

The event types this endpoint receives. Twelve are subscribable: booking.created, booking.cancelled, booking.rescheduled, booking.no_show, payment.succeeded, payment.refunded, booking.held, booking.reminder, booking.staff_reminder, booking.expired, payment.disputed and payment.dispute_closed. booking.no_show fires when the business marks a no-show, not when it clears one. The four payment events carry data.payment beside data.booking; payment.succeeded fires once when the charge succeeds, and payment.refunded once per increase of the refund total, whoever issued the refund. An endpoint receives only the events in this list. The webhooks guide describes each event and its body.

Array<string>

active

required

boolean

consecutive_failures

required

How many deliveries failed in a row. It returns to 0 after a success.

integer

last_success_at

string | null format: date-time

last_failure_at

string | null format: date-time

created_at

required

string format: date-time

secret

The signing secret. It is present ONLY on the create response. The stored form is sealed and no read path can reveal it again. Store it now. If you lose it, rotate it.

string

Example

{
  "events": [
    "booking.created"
  ]
}

401

The key is missing, malformed or revoked.

application/json

object

error

required

object

type

required

A stable machine-readable code. Match on this.

string

message

required

A sentence for a person. Do not match on this.

string

param

The field that caused the refusal, if one field did.

string

dimension

The plan limit that refused the request. It is present only on a 402, and only for a secret key or an account key. See the errors guide.

string

used

The current count for that dimension. It is present only on a 402, and only for an account key. It is absent when the refusal has no count to report. Absent and zero are different answers.

integer format: int64

limit

The cap for that dimension. It is present only on a 402, and only for an account key. A cap of zero is a real value.

integer format: int64

Example ^generated

{
  "error": {
    "type": "example",
    "message": "example",
    "param": "example",
    "dimension": "example",
    "used": 1,
    "limit": 1
  }
}

403

This is a server route and you sent a publishable key. Send a secret key from your server. The type field is secret_key_required.

application/json

object

error

required

object

type

required

A stable machine-readable code. Match on this.

string

message

required

A sentence for a person. Do not match on this.

string

param

The field that caused the refusal, if one field did.

string

dimension

The plan limit that refused the request. It is present only on a 402, and only for a secret key or an account key. See the errors guide.

string

used

The current count for that dimension. It is present only on a 402, and only for an account key. It is absent when the refusal has no count to report. Absent and zero are different answers.

integer format: int64

limit

The cap for that dimension. It is present only on a 402, and only for an account key. A cap of zero is a real value.

integer format: int64

Example ^generated

{
  "error": {
    "type": "example",
    "message": "example",
    "param": "example",
    "dimension": "example",
    "used": 1,
    "limit": 1
  }
}

404

There is no such resource in this workspace.

application/json

object

error

required

object

type

required

A stable machine-readable code. Match on this.

string

message

required

A sentence for a person. Do not match on this.

string

param

The field that caused the refusal, if one field did.

string

dimension

The plan limit that refused the request. It is present only on a 402, and only for a secret key or an account key. See the errors guide.

string

used

The current count for that dimension. It is present only on a 402, and only for an account key. It is absent when the refusal has no count to report. Absent and zero are different answers.

integer format: int64

limit

The cap for that dimension. It is present only on a 402, and only for an account key. A cap of zero is a real value.

integer format: int64

Example ^generated

{
  "error": {
    "type": "example",
    "message": "example",
    "param": "example",
    "dimension": "example",
    "used": 1,
    "limit": 1
  }
}

422

The request body or the query is not valid.

application/json

object

error

required

object

type

required

A stable machine-readable code. Match on this.

string

message

required

A sentence for a person. Do not match on this.

string

param

The field that caused the refusal, if one field did.

string

dimension

The plan limit that refused the request. It is present only on a 402, and only for a secret key or an account key. See the errors guide.

string

used

The current count for that dimension. It is present only on a 402, and only for an account key. It is absent when the refusal has no count to report. Absent and zero are different answers.

integer format: int64

limit

The cap for that dimension. It is present only on a 402, and only for an account key. A cap of zero is a real value.

integer format: int64

Example ^generated

{
  "error": {
    "type": "example",
    "message": "example",
    "param": "example",
    "dimension": "example",
    "used": 1,
    "limit": 1
  }
}

500

A fault on our side. Do not retry the same request in a loop. The type field is internal_error.

application/json

object

error

required

object

type

required

A stable machine-readable code. Match on this.

string

message

required

A sentence for a person. Do not match on this.

string

param

The field that caused the refusal, if one field did.

string

dimension

The plan limit that refused the request. It is present only on a 402, and only for a secret key or an account key. See the errors guide.

string

used

The current count for that dimension. It is present only on a 402, and only for an account key. It is absent when the refusal has no count to report. Absent and zero are different answers.

integer format: int64

limit

The cap for that dimension. It is present only on a 402, and only for an account key. A cap of zero is a real value.

integer format: int64

Example ^generated

{
  "error": {
    "type": "example",
    "message": "example",
    "param": "example",
    "dimension": "example",
    "used": 1,
    "limit": 1
  }
}

503

Two writes contended and one was rolled back. The request did nothing. Retry it. The type field is transient_failure.

application/json

object

error

required

object

type

required

A stable machine-readable code. Match on this.

string

message

required

A sentence for a person. Do not match on this.

string

param

The field that caused the refusal, if one field did.

string

dimension

The plan limit that refused the request. It is present only on a 402, and only for a secret key or an account key. See the errors guide.

string

used

The current count for that dimension. It is present only on a 402, and only for an account key. It is absent when the refusal has no count to report. Absent and zero are different answers.

integer format: int64

limit

The cap for that dimension. It is present only on a 402, and only for an account key. A cap of zero is a real value.

integer format: int64

Example ^generated

{
  "error": {
    "type": "example",
    "message": "example",
    "param": "example",
    "dimension": "example",
    "used": 1,
    "limit": 1
  }
}

Change an endpoint

Authorizations

Parameters

Path Parameters

Request Body required

Responses

200

Example

401

Example generated

403

Example generated

404

Example generated

422

Example generated

500

Example generated

503

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated