Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

List delivery attempts for a webhook

GET
/api/v1/webhooks/{id}/deliveries
curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/webhooks/example/deliveries?status=pending&page=1&limit=25' \
  --header 'Authorization: Bearer <token>'

One row per attempt, newest first; filter with status (pending, success, failed).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Query Parameters

Section titled “Query Parameters”
status
string
Allowed values: pending success failed
page
integer
default: 1 >= 1
limit
integer
default: 25 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

A page of deliveries

Media typeapplication/json
object
deliveries
required
Array<object>
object
_id
required
string
webhook_subscription_id
required
string
event_type
required
string
payload
required
object
key
additional properties
status
required
string
Allowed values: pending success failed
attempt
required
number
response_status_code
required
number | null
response_body_excerpt
required
string | null
error_message
required
string | null
delivered_at
required
string | null
created_at
required
string
key
additional properties
any
pagination
required
object
total
required
number
page
required
number
limit
required
number
pages
required
number
Example
{
  "deliveries": [
    {
      "status": "pending"
    }
  ]
}

400

Section titled “400”

Validation failed

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Section titled “401”

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Section titled “402”

Feature not available on the organization plan

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Section titled “403”

Role permission or token scope missing

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}