Delivery log, newest first

GET

/v1/webhooks/subscriptions/{id}/deliveries

curl --request GET \
  --url 'https://api.threadkite.app/v1/webhooks/subscriptions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/deliveries?limit=25&status=pending&event=lead.created' \
  --header 'Authorization: Bearer <token>'

• Threadkite API

Authorizations

• api_key
  webhooks:manage

Parameters

Path Parameters

id

required

string format: uuid

Query Parameters

limit

integer

default: 25 >= 1 <= 100

cursor

The nextCursor from the previous page

string

<= 200 characters

The nextCursor from the previous page

status

string

Allowed values: pending delivered failed

event

Only deliveries of this event

string

<= 120 characters

Example

lead.created

Only deliveries of this event

from

Only deliveries made at or after this

string format: date-time

Only deliveries made at or after this

to

Only deliveries made before this

string format: date-time

Only deliveries made before this

Responses

200

Media typeapplication/json

object

data

required

Array<object>

object

id

required

Also sent as Threadkite-Delivery and Idempotency-Key

string format: uuid

event

required

The event it carried, webhook_subscription.tested for a test, or event.<name>

string

status

required

string

Allowed values: pending delivered failed

attempts

required

Attempts made so far

number

responseCode

required

HTTP status of the last attempt

number

nullable

createdAt

required

string format: date-time

deliveredAt

required

string format: date-time

nullable

nextAttemptAt

required

When the next attempt is due, if retrying

string format: date-time

nullable

nextCursor

required

Pass as cursor to get the next page; null on the last page

string

nullable

Example

{
  "data": [
    {
      "event": "lead.created",
      "status": "pending"
    }
  ]
}

400

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

401

Missing or invalid API key

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

402

The organisation is on the Free plan (code upgrade_required)

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

feature

required

The feature that needs Pro

string

nullable

Allowed values: extraSeats connections aiAssistant aiReplies rules fullReports api inboxes bulkMessages videoMessages

upgradePath

required

Where to upgrade or pay, in the web app

string

Example

{
  "statusCode": 402,
  "code": "upgrade_required",
  "message": "Connections are part of Pro. Upgrade to connect texts, calls and more.",
  "feature": "extraSeats",
  "upgradePath": "/settings/billing"
}

403

The key does not have the scope (or the person the permission)

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

404

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

429

Rate limit reached

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

retryAfter

required

Seconds until another request will be accepted

number

Example

{
  "statusCode": 429,
  "code": "rate_limited",
  "message": "Too many requests. Each key can make 120 requests a minute; try again in 12 seconds.",
  "retryAfter": 12
}