modulr v0.2.0 Modulr.Resources.Notification

Link to this section Summary

Functions

Check if a webhook has failed since a given date/time (from)

Set up a Notification for a given customer

Retrieve a specific notification by unique reference for a given customer

List all notifications for a given customer

Link to this section Functions

Link to this function check_if_failed(id, params, driver \\ Comms.HttpDriver)

Check if a webhook has failed since a given date/time (from)

Example

  Modulr.Resources.Notification.check_if_failed("W123ABCD", %{
    from: "2017-01-28T01:01:01+0000"
  })
Link to this function create_for_customer(cid, params, driver \\ Comms.HttpDriver)

Set up a Notification for a given customer.

Example

  Modulr.Resources.Notification.create_for_customer("C123456", %{
    channel: "WEBHOOK",
    config: %{
      retry: true,
      secret: "01234567890123456789012345678912"},
      destinations: ["https://yourserver/endpoint"], 
      type: "PAYIN"
    }
  )
Link to this function get_for_customer(cid, nid, params \\ %{}, driver \\ Comms.HttpDriver)

Retrieve a specific notification by unique reference for a given customer.

Example

  Modulr.Resources.Notification.get_for_customer("C123456", "W123ABCD")
Link to this function list_for_customer(cid, params \\ %{}, driver \\ Comms.HttpDriver)

List all notifications for a given customer.

Example

  Modulr.Resources.Notification.list_for_customer("C123456")
Link to this function update_for_customer(cid, nid, params, driver \\ Comms.HttpDriver)