Send an event to a webhook Source

POST

/v1/hooks/{token}

const url = 'https://api.pocketbell.dev/v1/hooks/pbw_7fk2mq9xr4tlp8vn3wz6cb1s';
const options = {method: 'POST'};

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

curl --request POST \
  --url https://api.pocketbell.dev/v1/hooks/pbw_7fk2mq9xr4tlp8vn3wz6cb1s

Post any JSON, form or text (up to 64 KB). The Source’s templates turn it into a notification; with none, it reads as a summary of the event’s fields.

Parameters

Path Parameters

token

required

string

Example

pbw_7fk2mq9xr4tlp8vn3wz6cb1s

Responses

202

Received and queued.

application/json

object

required

string

status

required

Awaiting_answer for a question; awaiting_acknowledgment for a Critical notification, which repeats until acknowledged; scheduled when deliver_at is ahead.

string

Allowed values: queued scheduled awaiting_acknowledgment awaiting_answer

repeats

Critical only: false when the account already has 10 Critical notifications repeating. This one is delivered once, without repeats, and still waits for acknowledgment until it expires.

boolean

Example

{
  "id": "msg_01jz9k6q8r3tfv0x2m4n5p7s8a",
  "status": "queued"
}

404

No webhook Source has this URL.

application/json

object

error

required

object

code

required

string

message

required

string

details

Which fields were wrong, for invalid_request.

Array<object>

object

field

required

string

message

required

string

Example

{
  "error": {
    "code": "invalid_request"
  }
}

429

Rate_limited: too many at once, retry after the Retry-After header’s seconds; or monthly_limit_reached: the account’s notifications for the month are used up (a Critical one still goes out).

application/json

object

error

required

object

code

required

string

message

required

string

details

Which fields were wrong, for invalid_request.

Array<object>

object

field

required

string

message

required

string

Example

{
  "error": {
    "code": "invalid_request"
  }
}