Skip to main content

Get all webhooks

GET 

https://api.publicsquare.com/webhooks

Get a list of webhooks for the Account.

Permissions

  • webhook:read

Request

Query Parameters

    page int32

    Possible values: > 0 and <= 2147483647

    Page

    size int32

    Possible values: > 0 and <= 100

    Page size

Responses

OK

Schema
    pagination object
    total_itemsint32nullable

    Total number of records

    Example: 1020
    page_numberint32nullable

    Current page number

    Example: 23
    page_sizeint32

    Page size

    Example: 20
    total_pagesint32nullable

    Total number of pages

    Example: 51
    data object[]nullable

    Possible values: <= 100

  • Array [
  • idstringnullable

    Webhook ID

    Example: wbhk_BcA4TAFibe9UHgkY6pEjxzrya
    account_idstringnullable

    Account ID

    Example: acc_B518niGwGYKzig6vtrRVZGGGV
    environmentstringnullable

    Environment - Can be test or production

    Example: production
    keystringnullable

    Base64 RSA public key used for webhook signature verification

    Example: TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUEzK0ViU1hacTBpYXlmN1FOdStwN1I5OUxPQzltN0crZUhrY1VvUTdYNnFja05vaGxhMjViVW0xZXZBZ1RiN2RXZkxiT3kwVHZsczNBdkFKdEI0QVh5VjJtczJ4Y3d2NXhXakprbnl6MzNRUFVNNWRKQmQ1Z29oYmdLL2dwcVUzMWpkR0NCN2UyR0J4NWZhWEp4L0VnVEZrZjZoaDVBU3NlV0hSSEx2RjRIUk5zcmRVd1ovak5jODlnM2hHb0VPTWdSK240ZmVTYjBaSEw4ZmpYc2RIaVJkbG84VVhxRDZKRFdWcnJNbUdGZTZudXdYRUhaUGt5NnJhMTM1VG9yQThZOUlpWXhybEN1NFNncGhTN3N1Y0cwVnJMTGF0TVVOdW9ZRW9PVFBJMFVGRmtLY3EwdlRCRzhINXdUMFNvR2xpNUVpL1FYK0RoWWRPMFN3OGdXZUY4aHdJREFRQUI=
    created_atdate-timenullable

    Date webhook was created

    Example: 2024-06-30T01:02:29.212Z
    modified_atdate-timenullable

    Date webhook was modified

    Example: 2024-06-30T01:02:29.212Z
    urlstringrequired

    URL of where to send notifications for provided event types

    Possible values: non-empty and <= 250 characters

    Example: https://examplewebsite.com/notification
    event_typesstring[]required

    A list of event types to send notifications for

    Possible values: >= 1

    Example: ["connection-invitation:accept","connection-invitation:decline","seller-onboarding:update"]
  • ]

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");
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
— query
— query
ResponseClear

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