Get a webhook delivery with its attempts

GET

/v1/webhook-deliveries/{webhook_delivery_id}

package main

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

func main() {

  url := "https://api.feitpay.com/v1/webhook-deliveries/example"

  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(res)
  fmt.Println(string(body))

}

const url = 'https://api.feitpay.com/v1/webhook-deliveries/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

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

Authorizations

ApiKey
Session

Parameters

Path Parameters

webhook_delivery_id

required

string

Header Parameters

FeitPay-Organization

string

Active organization for dashboard sessions. Ignored for API keys (the key determines the organization).

Responses

200

Delivery with attempts.

application/json

object

required

string

object

required

string

Allowed value: webhook_delivery

livemode

required

boolean

endpoint_id

required

string

endpoint_url

required

string

event_id

required

string

event_type

required

string

object_type

required

string

object_id

required

string

status

required

string

Allowed values: pending delivering succeeded failed dead

attempt_count

required

integer

next_attempt_at

required

string format: date-time

last_response_status

required

integer | null

last_error

required

string | null

succeeded_at

required

string | null format: date-time

created_at

required

string format: date-time

attempts

Array<object>

object

attempt

required

integer

trigger

required

string

Allowed values: automatic manual_retry replay

started_at

required

string format: date-time

duration_ms

required

integer

response_status

required

integer | null

response_excerpt

required

string | null

error

required

string | null

Example

{
  "object": "webhook_delivery",
  "status": "pending",
  "attempts": [
    {
      "trigger": "automatic"
    }
  ]
}

401

Missing or invalid credentials.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

403

Authenticated but not permitted.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

404

Resource not found (or not visible to this tenant).

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

429

Too many requests. See Retry-After.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

Headers

Retry-After

integer