MergeHRISClient.Api.WebhookReceivers (MergeHRISClient v1.0.3) View Source

API calls for all endpoints tagged WebhookReceivers.

Link to this section Summary

Functions

webhook_receivers_create(connection, authorization, x_account_token, webhook_receiver_request, opts \\ [])

Creates a WebhookReceiver object with the given values.

webhook_receivers_list(connection, authorization, x_account_token, opts \\ [])

Returns a list of WebhookReceiver objects.

Link to this section Functions

webhook_receivers_create(connection, authorization, x_account_token, webhook_receiver_request, opts \\ [])

Specs

webhook_receivers_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  MergeHRISClient.Model.WebhookReceiverRequest.t(),
  keyword()
) :: {:ok, MergeHRISClient.Model.WebhookReceiver.t()} | {:error, Tesla.Env.t()}

Creates a WebhookReceiver object with the given values.

Parameters

connection (MergeHRISClient.Connection): Connection to server
authorization (String.t): Should include 'Bearer ' followed by your test/production API Key.
x_account_token (String.t): Token identifying the end user.
webhook_receiver_request (WebhookReceiverRequest):
opts (KeywordList): [optional] Optional parameters
Returns

on success {:error, Tesla.Env.t} on failure

webhook_receivers_list(connection, authorization, x_account_token, opts \\ [])

Specs

webhook_receivers_list(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, [MergeHRISClient.Model.WebhookReceiver.t()]} | {:error, Tesla.Env.t()}

Returns a list of WebhookReceiver objects.

Parameters

connection (MergeHRISClient.Connection): Connection to server
authorization (String.t): Should include 'Bearer ' followed by your test/production API Key.
x_account_token (String.t): Token identifying the end user.
opts (KeywordList): [optional] Optional parameters
Returns

, ...]} on success {:error, Tesla.Env.t} on failure