logo

Retrieve a webhook tracking log

Retrieves a webhook tracking log record with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

Webhook tracking log record retrieved.

Response Schema: application/json
id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

eventType
string (EventType)

Type of Rebilly event.

Enum: "account-password-reset-requested" "account-verification-requested" "aml-list-possibly-matched" "application-instance-disabled" "application-instance-enabled" "balance-transaction-settled" "customer-created" "customer-one-time-password-requested" "dispute-created" "dispute-modified" … 55 more
entityId
string

ID of the main entity related to the event type.

url
string

URL where webhook is sent.

method
string

HTTP method used to send webhook.

object

HTTP headers used to send webhook.

property name*
additional property
string
responseCode
integer

HTTP code response.

responseBody
string

Response body received.

payload
string

Webhook payload.

source
string

Webhook source.

Enum: "webhooks" "rules"
attempt
integer

Webhook attempt number.

sentTime
string <date-time>

Date and time when the webhook is sent.

initiatedTime
string <date-time>

Date and time when the webhook initiated.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/tracking/webhooks/{id}
Request samples 
const entry = await api.tracking.getWebhookTrackingLog({id: 'foobar-001'});
console.log(entry.fields.eventType);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "eventType": "account-password-reset-requested",
  • "entityId": "string",
  • "url": "string",
  • "method": "POST",
  • "headers": {
    },
  • "responseCode": 0,
  • "responseBody": "string",
  • "payload": "string",
  • "source": "webhooks",
  • "attempt": 0,
  • "sentTime": "2019-08-24T14:15:22Z",
  • "initiatedTime": "2019-08-24T14:15:22Z",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Schedule a resend webhook attempt