Skip to content

Added Authvia source for Review #6897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Aug 12, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions src/connections/sources/catalog/cloud-apps/authvia/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "Authvia Source"
---

TXT2PAY from [Authvia](https://www.authvia.com/) is the easiest way to engage your customers for bills, invoices, donations, disbursement and any other payment use case you may have. Get paid faster without the hassle of PCI compliance.

This source is maintained by <Authvia>. For any issues with the source, [contact their Support team](mailto:[email protected]).

## Getting started

1. From your workspace's [Sources catalog page](https://app.segment.com/authvia/sources/catalog) click **Add Source**.
2. Search for "Authvia" in the Sources Catalog, select Authvia, and click **Add Source**.
3. On the next screen, give the Source a name configure any other settings.

- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev).

4. Click **Add Source** to save your settings.
5. Copy the Write key from the Segment UI.
6. Go to [https://www.authvia.com/forms/setup-twilio-segment-and-authvia/](https://www.authvia.com/forms/setup-twilio-segment-and-authvia/) and enter your Authvia Client ID and Secret, along with your Write Key. You will also pick your region and choose which events you would like to subscribe to. If you do not have an Authvia Client ID and Secret, request access here [(https://authvia.atlassian.net/servicedesk/customer/portal/1/group/1/create/31)](https://authvia.atlassian.net/servicedesk/customer/portal/1/group/1/create/31

## Stream

Authvia uses our stream Source component to send Segment event data. It uses a server-side (select from `track`, `identify`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.

The default behavior is for Authvia to pass the customer reference associated with the payer as the userId.

## Events

The table below lists events that Authvia sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. Authvia includes the `userId`.

| Event Name | Description |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| Actions Created | An action was created for a customer to complete. An Action could be a payment, signature, data collection and more. |
| Actions Updated | A customer completed the action. An Action could be a payment, signature, data collection and more. |
| Customer Created | A new customer was created in Authvia |
| Customer Updated | An existing customer was updated |
| Customer Deleted | An existing Customer was Deleted from Authvia |
| Business Process Created | A new Business Process (Conversation) was created for a customer |
| Business Process Updated | A customer has completed some, or all Actions in a business process. Alternatively, the Business Process was cancelled or it expired. |