Skip to main content

Get all webhook events

GET 

https://api.publicsquare.com/webhooks/:webhookId/events

Get a list of webhook events by webhook ID for the Account.

Permissions

  • webhook:read

Request

Path Parameters

    webhookId stringrequired

Query Parameters

    status string[]

    List of statuses to filter by

    start_dt string

    Inclusive start date to filter records by

    end_dt string

    Exclusive end date to filter records by

    event_type string[]

    List of event types to filter by

    query string

    Filter by query

    page int32

    Possible values: > 0 and <= 2147483647

    Page

    size int32

    Possible values: > 0 and <= 100

    Page size

Responses

OK

Schema
    pagination object
    total_itemsinteger<int32>nullable

    Total number of records

    Example: 1020
    page_numberinteger<int32>nullable

    Current page number

    Example: 23
    page_sizeinteger<int32>

    Page size

    Example: 20
    total_pagesinteger<int32>nullable

    Total number of pages

    Example: 51
    data object[]nullable

    Possible values: <= 100

  • Array [
  • idstringnullable

    Webhook event ID

    Example: whe_2S8RsJECwUKHGbfL2AAaDM2AW
    event_idstringnullable

    Event ID

    Example: evnt_5jxWRFNLCAWeegrkCAG3a9DGc
    webhook_idstringnullable

    Webhook ID

    Example: wbhk_BcA4TAFibe9UHgkY6pEjxzrya
    account_idstringnullable

    Account ID

    Example: acc_B518niGwGYKzig6vtrRVZGGGV
    environmentstringnullable

    Environment - Can be test or production

    Example: production
    event_typestringnullable

    Event type

    Example: connection:update
    entity_idstringnullable

    Entity ID of the event

    Example: pmt_2YKewBonG4tgk12MheY3PiHDy
    entity_typestringnullable

    Entity type of the event

    Example: payment
    last_delivery_attemptstring<date-time>nullable

    Date webhook was last attempted for delivery

    Example: 2024-06-30T01:02:29.212Z
    delivery_attemptsinteger<int32>

    Number of delivery attempts

    Example: 2
    statusstringnullable

    Webhook event status

    Example: delivered
    requeststringnullable

    Request body

    response_status_codeinteger<int32>nullable

    Response HTTP status code

    responsestringnullable

    Response body

    created_atstring<date-time>nullable

    Date webhook event was created

    Example: 2024-06-30T01:02:29.212Z
  • ]

Authorization: X-API-KEY

name: X-API-KEYtype: apiKeyscopes: webhook:readdescription: Authorization by API Key inside request's X-API-KEY headerin: header
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.publicsquare.com/webhooks/:webhookId/events");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-KEY", "<X-API-KEY>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://api.publicsquare.com
Auth
Parameters
— pathrequired
— query
— query
— query
— query
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!