Aegis
Aegis Premier Solutions is a nonprofit CRM platform used for donor management, fundraising tools, analytics and reporting.
Connect Anedot to Aegis
To connect your Anedot fundraising account to Aegis, follow the steps below:
-
Access the Settings > Integrations > Directory tab within your fundraising account.
-
Next, click the blue + New Connection button in the upper right corner of the page.
-
Select Aegis from the integrations directory.
-
Select the Action Pages you would like synced with Aegis. The default is All Pages.
- To exclude pages, enter a comma-separated list of the Action Page IDs.
- Optionally, you can scope the integration to only send team-specific data to Aegis.
-
Enter your Aegis Premier Solutions URL .
-
Enter your Aegis Premier Solutions Username .
-
Enter your Aegis Premier Solutions Password .
-
Apply your Context Key .
-
Add your Fund Code .
-
Click the blue Save button to complete the connection!
The Action Pages, Team, and credentials can be modified at any time post-setup.
For further assistance locating these items, please contact Aegis Technical Support directly.
Data Relays
Anedot will relay data to Aegis for both Donation and Lead Pages .
Donation and Lead Pages are required to have an
appeal_id
Custom Hidden Fields
applied for successful relays.
We process
custom_flag
and
custom_data_field
as
Custom Hidden Fields
to get the corresponding data sent to new partners in Aegis.
Custom Flags
(
custom_flag
)
In the Action Page Builder, add a Custom Hidden Field with the key:
custom_flag_1
. Subsequent fields should be set up as
custom_flag_2
,
custom_flag_3
, etc.
A Page Specific Value will need to be applied to each Custom Hidden Field within the Settings > Sharing > Page Specific Values tab of the Builder.
All custom field names and values must be exact in Action Pages (or data will not relay properly and cause issues in Aegis) .
Custom Data Fields (
custom_data_field
)
In the Action Page Builder, add a Custom Hidden Field with the key:
custom_data_field_1
.
To better support Aegis product handling, we provide support for a
Custom Hidden Field
called
product_sku
.
When added, the
product_sku
field will appear under the
productOrders
area of relays as
productSKU
.
Data in Aegis
Once the relay is successful, you should be able to look up the Transaction under the Partners > Locate Transactions tab (you will need to look up the individual transaction or contact).
Sample transaction from Anedot viewed in Aegis CRM.
Field Mappings
Relay Fields
Anedot Field | Aegis Field |
---|---|
fundcode ( from Setup , Aegis Field) amount (x100) “true” or “false” | gifts { fundCode pledgeID giftAmount applyToPledge } |
“internet” | channel |
donation { amount (x100) lastDigits “Paid” payMethod (Donations) } | payment { amount number status paymentType } |
"[firstName] [lastName]" address { city region country line1 line2 postalCode } | shipping { shipto shiptoCity shiptoState shiptoCountry shiptoAddress1 shiptoAddress2 shiptoPostalCode } |
Aegis Field | partnerID |
appeal_id* | appealCode |
value (from Product Details) “0.0”** fundcode ( from Setup , Aegis Field) “1” InternalSKU (from Product Details) | productOrders { price discount fundCode quantity productSKU } |
(Submission) id | referenceNumber |
created_at | transactionDate |
“Anedot UID: [Submission id] OnlineContribution (Source:[source_code])” | transactionNote |
totalAmount (x100) [Anedot stores amounts in cents] | totalTransactionAmount |
* Custom hidden field that must be added to the Anedot AP in order to be relayed.
** The discount will be greater than 0 if the donation amount is below the value amount specified in the Product’s Details.
Payload Data
Request Headers
`{``}`
Request Body (Success) (
Create Partner
)
`{`
"createPartner": `{`
"city": "New Orleans",
"email": "[[email protected]](/cdn-cgi/l/email-protection)",
"address1": "1340 Poydras St",
"address2": null,
"lastName": "Dot",
"firstName": "Annie",
"stateProv": "LA",
"postalCode": "70112",
"countryCode": "US",
"customFlags": [],
"originSource": "Web",
"partnerPhones": [
`{`
"number": "2015550123"
`}`
],
"customDataFields": []
`}`,
"createDonation": `{`
"gifts": [
`{`
"fundCode": "DEFAULT",
"pledgeID": null,
"giftAmount": 25,
"applyToPledge": false
`}`
],
"channel": "Internet",
"payment": `{`
"amount": 25,
"number": "5454",
"status": "Paid",
"paymentType": "CreditCard"
`}`,
"shipping": `{`
"shipto": "Annie Dot",
"shiptoCity": "New Orleans",
"shiptoState": "LA",
"shiptoCountry": "US",
"shiptoAddress1": "1340 Poydras St",
"shiptoAddress2": null,
"shiptoPostalCode": "70112"
`}`,
"partnerID": "2617081",
"appealCode": "W2403_TPOC",
"productOrders": [
`{`
"price": 11.55,
"discount": 0,
"fundCode": "DEFAULT",
"quantity": 1,
"productSKU": "PK_POC_3DAY_GEN1"
`}`
],
"referenceNumber": "53b5e566-7b92-4913-9c50-b2caf262d56d",
"transactionDate": "2024-03-29T14:30:13.738Z",
"transactionNote": "Anedot UID: 53b5e566-7b92-4913-9c50-b2caf262d56d\nOnline Contribution (Source: WEB)",
"totalTransactionAmount": 25
`}`,
"findPartnerByEmail": `{`
"get": "partner/Email"
`}`,
"findPartnerByNameAndAddress": `{`
"get": "partner/Search"
`}`
`}`
Request Body (Success) (
Create Donation
)
`{`
"gifts": [
`{`
"fundCode": "DEFAULT Test Fund",
"pledgeID": null,
"giftAmount": 50,
"applyToPledge": false
`}`
],
"channel": "Internet",
"payment": `{`
"amount": 50,
"number": "1111",
"status": "Paid",
"paymentType": "CreditCard"
`}`,
"shipping": `{`
"shipto": "Annie Dot",
"shiptoCity": "New Orleans",
"shiptoState": "LA",
"shiptoCountry": "US",
"shiptoAddress1": "1340 Poydras Street",
"shiptoAddress2": null,
"shiptoPostalCode": "70113"
`}`,
"partnerID": "0000000",
"appealCode": "W0000A0A",
"productOrders": null,
"referenceNumber": "affa9ef5-f4c3-4984-be25-5616abe46237",
"transactionDate": "2023-01-25T15:30:55.851Z",
"transactionNote": "Anedot UID: affa9ef5-f4c3-4984-be25-5616abe46237\nOnline Contribution (Source: stub)",
"totalTransactionAmount": 50
`}`
Request Body (Error)
null
Response Body (Success)
`{`
"Gifts": [
`{`
"FundCode": "DEFAULT Test Fund",
"PledgeID": null,
"GiftAmount": 50,
"ApplyToPledge": false,
"MatchingContactID": null,
"EstimatedPercentage": null
`}`
],
"Notes": [],
"Channel": "Internet",
"Payment": `{`
"Bank": null,
"City": null,
"Amount": 50,
"Number": "1111",
"Status": "Received",
"Country": null,
"ExpDate": null,
"ExtraID": null,
"Address1": null,
"Address2": null,
"LastName": null,
"FirstName": null,
"MiddleName": null,
"PostalCode": null,
"PaymentType": "CreditCard",
"ContactPhone": null,
"EmailAddress": null,
"StateProvince": null,
"UpdatePrimaryEmailAddress": false,
"UpdatePrimaryMailingAddress": false
`}`,
"Shipping": `{`
"Shipto": "Annie Dot",
"ShiptoCity": "New Orleans",
"ShiptoState": "LA",
"ShippingNote": null,
"ShiptoCountry": "US",
"ShippingMethod": null,
"ShiptoAddress1": "1340 Poydras Street",
"ShiptoAddress2": null,
"ShiptoPostalCode": "70113",
"ShippingOverridden": false
`}`,
"BatchType": "Web",
"PartnerID": "0000000",
"TaxAmount": 0,
"AppealCode": "W0000A0A",
"Attributes": [],
"RecordedBy": null,
"MediaOutlet": null,
"SegmentCode": null,
"MediaProgram": null,
"ShippingCost": 0,
"BatchCategory": null,
"InvoiceNumber": "2213291",
"ProductOrders": [],
"ReferenceNumber": "affa9ef5-f4c3-4984-be25-5616abe46237",
"TransactionDate": "2023-01-25T15:30:55.851+00:00",
"TransactionNote": "Anedot UID: affa9ef5-f4c3-4984-be25-5616abe46237\nOnline Contribution (Source: stub)",
"Acknowledgements": [],
"DefaultPaymentType": null,
"ResponsesOverridden": false,
"TotalTransactionAmount": 50
`}`
Response Body when
productOrders
is present
`{`
"create_donation": `{`
"gifts": [
`{`
"fundCode": "DEFAULT Pathway to Victory Ministry Fund",
"pledgeID": null,
"giftAmount": 12,
"applyToPledge": false
`}`
],
"channel": "Internet",
"payment": `{`
"amount": 12,
"number": "5454",
"status": "Paid",
"paymentType": "CreditCard"
`}`,
"shipping": `{`
"shipto": "Annie Dot",
"shiptoCity": "New Orleans",
"shiptoState": "LA",
"shiptoCountry": "US",
"shiptoAddress1": "1340 Poydras St",
"shiptoAddress2": null,
"shiptoPostalCode": "70114"
`}`,
"partnerID": "2557459",
"appealCode": "W2207A1A",
"productOrders": [
`{`
"discount": 0,
"fundCode": "DEFAULT Pathway to Victory Ministry Fund",
"quantity": 1,
"productSKU": "2452808"
`}`
],
"referenceNumber": "ae2f4940-1c3e-4a07-9d2e-69653e3bce2c",
"transactionDate": "2023-11-17T20:37:16.867Z",
"transactionNote": "Anedot UID: ae2f4940-1c3e-4a07-9d2e-69653e3bce2c\nOnline Contribution (Source: Web)",
"totalTransactionAmount": 12
`}`,
"find_partner_by_email": `{`
"get": "partner/Email"
`}`,
"find_partner_by_name_and_address": `{`
"get": "partner/Search"
`}`
`}`
Response Body (Error)
`{``}`
Response Body (Failure)
`{`
"Message": "The appeal could not be found in Aegis CRM. Appeal Code: 'W0000A0A'."
`}`
Response Status (Success)
201
Response Status (Error)
null
Response Status (Failure)
400
Related Articles
Campaign Monitor NationBuilder Order Desk Trail Blazer Email Octopus