Class: VitableConnect::Resources::WebhookEvents

Inherits:
Object
  • Object
show all
Defined in:
lib/vitable_connect/resources/webhook_events.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ WebhookEvents

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of WebhookEvents.

Parameters:



90
91
92
 
# File 'lib/vitable_connect/resources/webhook_events.rb', line 90

def initialize(client:)
  @client = client
end

Instance Method Details

#list(created_after: nil, created_before: nil, event_name: nil, limit: nil, page: nil, resource_id: nil, resource_type: nil, request_options: {}) ⇒ VitableConnect::Internal::PageNumberPage<VitableConnect::Models::WebhookEvent>

Some parameter documentations has been truncated, see Models::WebhookEventListParams for more details.

Retrieves a paginated list of webhook events for the authenticated organization. Supports filtering by event name, resource type, resource ID, and date range.

Parameters:

Returns:

See Also:



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/vitable_connect/resources/webhook_events.rb', line 53

def list(params = {})
  parsed, options = VitableConnect::WebhookEventListParams.dump_request(params)
  query = VitableConnect::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "v1/webhook-events",
    query: query,
    page: VitableConnect::Internal::PageNumberPage,
    model: VitableConnect::WebhookEvent,
    options: options
  )
end

#list_deliveries(event_id, request_options: {}) ⇒ VitableConnect::Models::WebhookEventListDeliveriesResponse

Retrieves all delivery attempts for a webhook event. Returns up to 100 deliveries. Each delivery includes a computed status field (Pending, In Progress, Delivered, or Failed).

Parameters:

Returns:

See Also:



78
79
80
81
82
83
84
85
 
# File 'lib/vitable_connect/resources/webhook_events.rb', line 78

def list_deliveries(event_id, params = {})
  @client.request(
    method: :get,
    path: ["v1/webhook-events/%1$s/deliveries", event_id],
    model: VitableConnect::Models::WebhookEventListDeliveriesResponse,
    options: params[:request_options]
  )
end

#retrieve(event_id, request_options: {}) ⇒ VitableConnect::Models::WebhookEventRetrieveResponse

Retrieves a single webhook event by its prefixed ID. Returns 404 if the event does not exist or belongs to a different organization.

Parameters:

Returns:

See Also:



17
18
19
20
21
22
23
24
 
# File 'lib/vitable_connect/resources/webhook_events.rb', line 17

def retrieve(event_id, params = {})
  @client.request(
    method: :get,
    path: ["v1/webhook-events/%1$s", event_id],
    model: VitableConnect::Models::WebhookEventRetrieveResponse,
    options: params[:request_options]
  )
end