List Webhook Deliveries

Intent

Reads the available webhook deliveries as a pageable collection without changing them.

When to call it

Call this when an interface, sync, or support workflow needs to inspect webhook deliveries. Use the filters and paging controls shown below to limit the result.

Access boundary

Authorize the request with a token that carries webhooks:read or webhooks:write.

Successful result

A successful request returns 200. The response schema below defines the body your integration receives.

Operational notes

List webhook deliveries.

Deliveries are all the attempts to deliver a webhook event to an endpoint.

Scopes: webhooks:read webhooks:write

GET

webhooks

deliveries

List Webhook Deliveries

curl --request GET \
  --url https://api.getruba.com/v1/webhooks/deliveries \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getruba.com/v1/webhooks/deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/webhooks/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/webhooks/deliveries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/webhooks/deliveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "succeeded": true,
      "http_code": 123,
      "response": "<string>",
      "webhook_event": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "skipped": true,
        "payload": "<string>",
        "is_archived": true,
        "last_http_code": 123,
        "succeeded": true
      }
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Query Parameters

endpoint_id

Filter by webhook endpoint ID.

start_timestamp

string<date-time> | null

Filter deliveries after this timestamp.

end_timestamp

string<date-time> | null

Filter deliveries before this timestamp.

succeeded

boolean | null

Filter by delivery success status.

query

string | null

Query to filter webhook deliveries.

http_code_class

enum<string> | null

Filter by HTTP response code class (2xx, 3xx, 4xx, 5xx).

Available options:

2xx,

3xx,

4xx,

5xx

event_type

Filter by webhook event type.

Available options:

checkout.created,

checkout.updated,

checkout.expired,

customer.created,

customer.updated,

customer.deleted,

customer.state_changed,

customer_seat.assigned,

customer_seat.claimed,

customer_seat.revoked,

member.created,

member.updated,

member.deleted,

order.created,

order.updated,

order.paid,

order.refunded,

subscription.created,

subscription.updated,

subscription.active,

subscription.canceled,

subscription.uncanceled,

subscription.revoked,

subscription.past_due,

refund.created,

refund.updated,

product.created,

product.updated,

benefit.created,

benefit.updated,

benefit_grant.created,

benefit_grant.cycled,

benefit_grant.updated,

benefit_grant.revoked,

organization.updated

page

integer

default:1

Page number, defaults to 1.

limit

integer

default:10

Size of a page, defaults to 10. Maximum is 100.

Response

Successful Response

items

WebhookDelivery · object[]

required

Show child attributes

pagination

Pagination · object

required

Show child attributes

Redeliver Webhook Event### Intent Runs the redeliver webhook event action. ### When to call it Call this when your workflow reaches the point where it must redeliver webhook event. ### Access boundary Authorize the request with a token that carries `webhooks:write`. ### Successful result A successful request returns `202`. The response schema below defines the body your integration receives. ### Operational notes Schedule the re-delivery of a webhook event. **Scopes**: `webhooks:write`

List Webhook Deliveries

curl --request GET \
  --url https://api.getruba.com/v1/webhooks/deliveries \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getruba.com/v1/webhooks/deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/webhooks/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/webhooks/deliveries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/webhooks/deliveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "succeeded": true,
      "http_code": 123,
      "response": "<string>",
      "webhook_event": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "skipped": true,
        "payload": "<string>",
        "is_archived": true,
        "last_http_code": 123,
        "succeeded": true
      }
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Read This First

Create a Sale

Collect and Reconcile

Manage Recurring Revenue

Model Customer Access

Power the Customer Portal

Configure the Platform

React to State Changes

List Webhook Deliveries

Intent

When to call it

Access boundary

Successful result

Operational notes

Authorizations

Query Parameters

Response