Skip to content

Latest commit

 

History

History
150 lines (104 loc) · 4.58 KB

WebhookEventsApi.md

File metadata and controls

150 lines (104 loc) · 4.58 KB
Raw

.WebhookEventsApi

All URIs are relative to https://api.pandadoc.com

Method HTTP request Description
detailsWebhookEvent GET /public/v1/webhook-events/{id} Get webhook event by uuid
listWebhookEvent GET /public/v1/webhook-events Get webhook event page

detailsWebhookEvent

WebhookEventDetailsResponse detailsWebhookEvent()

Example

import * as pd_api from 'pandadoc-node-client';

// replace it with your API key
const API_KEY = "YOUR_API_KEY";
const configuration = pd_api.createConfiguration(
    { authMethods: {apiKey: `API-Key ${API_KEY}`} }
);
const apiInstance = new pd_api.WebhookEventsApi(configuration);

const body:pd_api.WebhookEventsApiDetailsWebhookEventRequest = {
  // string | Webhook event uuid
  id: "id_example",
};

apiInstance.detailsWebhookEvent(body).then((data) => {
  console.log('API called successfully. Returned data: %o', data);
}).catch((error) => console.error(error));

Parameters

Name Type Description Notes
id [string] Webhook event uuid defaults to undefined

Return type

WebhookEventDetailsResponse

Authorization

apiKey, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Get webhook event by uuid -
401 Authentication error -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to README]

listWebhookEvent

WebhookEventPageResponse listWebhookEvent()

Example

import * as pd_api from 'pandadoc-node-client';

// replace it with your API key
const API_KEY = "YOUR_API_KEY";
const configuration = pd_api.createConfiguration(
    { authMethods: {apiKey: `API-Key ${API_KEY}`} }
);
const apiInstance = new pd_api.WebhookEventsApi(configuration);

const body:pd_api.WebhookEventsApiListWebhookEventRequest = {
  // number | Number of element in page
  count: 0,
  // number | Page number
  page: 0,
  // Date | Filter option: all events from specified timestamp (optional)
  since: new Date('1970-01-01T00:00:00.00Z'),
  // Date | Filter option: all events up to specified timestamp (optional)
  to: new Date('1970-01-01T00:00:00.00Z'),
  // Array<WebhookEventTriggerEnum> | Filter option: all events of type (optional)
  type: [
    "document_state_changed",
  ],
  // Array<WebhookEventHttpStatusCodeGroupEnum> | Filter option: all events of http status code (optional)
  httpStatusCode: [
    400,
  ],
  // Array<WebhookEventErrorEnum> | Filter option: all events with following error (optional)
  error: [
    "TIMEOUT_ERROR",
  ],
};

apiInstance.listWebhookEvent(body).then((data) => {
  console.log('API called successfully. Returned data: %o', data);
}).catch((error) => console.error(error));

Parameters

Name Type Description Notes
count [number] Number of element in page defaults to undefined
page [number] Page number defaults to undefined
since [Date] Filter option: all events from specified timestamp (optional) defaults to undefined
to [Date] Filter option: all events up to specified timestamp (optional) defaults to undefined
type Array<WebhookEventTriggerEnum> Filter option: all events of type (optional) defaults to undefined
httpStatusCode Array<WebhookEventHttpStatusCodeGroupEnum> Filter option: all events of http status code (optional) defaults to undefined
error Array<WebhookEventErrorEnum> Filter option: all events with following error (optional) defaults to undefined

Return type

WebhookEventPageResponse

Authorization

apiKey, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Page of webhook events -
401 Authentication error -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to README]