In This Article:

    Activity Form Metadata

    In This Article:

      Recent software changes are highlighted in red.

      This API call returns the list of activity forms with basic info. 

      Request

      • Method: GET
      • URL: https://dev-api.salsalabs.org/api/developer/ext/v1/activities/UUID/metadata

      Parameters

      Name

      Type

      Mandatory/Optional

      Description

      UUID

      UUID

      mandatory

      UUID that identifies specific form

       

      Example: https://dev-api.salsalabs.org/api/developer/ext/v1/activities/ce5025ce-e519-4c6d-a604-54804c4dce23/metadata

      Response

      • Sign-up Form
      • Petition Form
      • Targeted Action Form
      • Fundraise Form
      • Ticketed Event Form
      • P2P Event Form

      Generic Response Fields

      Name
      Type
      Description
      id

      UUID

      unique response identifier

      timestamp

      Date

      call timestamp

      header

      Object

      contains technical data

      processingTime

      Long

      processing time in milliseconds

      serverId

      String

      server name

      payload

      Object

      response data

      type

      String

      activity form type. Values:

      • FUNDRAISE
      • P2P_EVENT
      • PETITION
      • SUBSCRIBE
      • TARGETED_LETTER
      • TICKETED_EVENT

      id

      UUID

      activity form ID

      name

      String

      form name

      description

      String

      form description

      createDate

      Date

      form creation date. ISO_8601 formatted String with a GMT timezone

      publishDate

      Date

      form publish date. ISO_8601 formatted String with a GMT timezone

      modifiedDate

      Date

      form modified date. ISO_8601 formatted String with a GMT timezone

      status

      String

      form status will be one of...

      • PUBLISHED
      • DRAFT

      visibility

       

      String

      for visibility to public. Values:

      • PRIVATE

      • PUBLIC

      pageUrl

       String

       hosted page URL

      widgetScript

       String

       form widget script that can be embedded into any page

      googleAnalytics

       Boolean

       if analytics is enabled

      facebookPixel

       Boolean

       if pixel is enabled

      formFields

      Object

       collection of configured form fields with the following properties:

      • id

      • name

      • inbound parameter name

       

      Fundraise Form

      Response Fields

      Generic Fields: Response

      {
        "id""240b2fc1-382c-40db-9144-af035b548824",
        "timestamp""2018-02-06T16:09:57.576Z",
        "header": {
          "processingTime": 88,
          "serverId""local"
        },
        "payload": {
          "type""FUNDRAISE",
          "id""5d422d3b-c77c-4590-86ed-e1136f0c4f66",
          "name""name",
          "description""description",
          "createDate""2018-02-06T16:09:57.576Z",
          "publishDate""2018-02-06T16:09:57.576Z",
          "modifiedDate""2018-02-06T16:09:57.576Z",
          "status""Published",
          "visibility""Public",
          "pageUrl""https://fundraise/salsalabs.org",
          "widgetScript""<a href=\"https://svm5.test.igniteaction.net/frm1form\" target=\"_blank\" style=\"background:rgb(152, 0, 0);padding:10px;margin:10px 0px;text-align:center;text-decoration:none;font-size:12pt;color:#222222;font-family:Arial, Helvetica, sans-serif;display:inline-block;\">Sign Up!</a>",
          "googleAnalytics"true,
          "facebookPixel"false,
          "formFields": [
            {
              "id""8c83efdf-d549-49d5-97ff-035a7af32c05",
              "name""email",
              "inboundParameterName""email"
            },
            {
              "id""c9cd5115-ff76-4205-a1c1-75ac78fdf666",
              "name""field_",
              "inboundParameterName""field"
            }
          ]
        }
      }

      P2P Event Form

      Response Fields

      Generic Fields

      Name
      Type
      Description

      startDate

      Date

      event start date. ISO_8601 formatted String with a GMT timezone

      endDate

      Date

      event end date. ISO_8601 formatted String with a GMT timezone

      allDay

      Boolean

      all day or not

      publicEventName

      String

      public event name

      timezone

      String

      time zone

      venueName

      String

      venue name

      addressLine1

      String

      address line 1

      addressLine2

      String

      address line 2

      city

      String

      city

      state

      String

      state

      zipCode

      String

      zip

      registrations

      List

      list of P2P event tickets/available registrations.

      Ticket attributes:

      • name - String

      • price - double

       

       

      Response

      {
        "id""eb6268d5-eb9a-443b-8caf-7856f8b38d26",
        "timestamp""2018-02-06T16:18:54.930Z",
        "header": {
          "processingTime": 88,
          "serverId""local"
        },
        "payload": {
          "type""P2P_EVENT",
          "id""4d36245e-b5b2-42b0-96e6-8b44e9a2891d",
          "name""name",
          "description""description",
          "createDate""2018-02-06T16:18:54.930Z",
          "publishDate""2018-02-06T16:18:54.930Z",
          "modifiedDate""2018-02-06T16:18:54.930Z",
          "status""Published",
          "visibility""Public",
          "pageUrl""https://fundraise/salsalabs.org",
          "widgetScript""<a href=\"https://svm5.test.igniteaction.net/frm1form\" target=\"_blank\" style=\"background:rgb(152, 0, 0);padding:10px;margin:10px 0px;text-align:center;text-decoration:none;font-size:12pt;color:#222222;font-family:Arial, Helvetica, sans-serif;display:inline-block;\">Sign Up!</a>",
          "googleAnalytics"true,
          "facebookPixel"false,
          "formFields": [
            {
              "id""1a5d6fc9-1c1a-46bf-802b-097638e0ae55",
              "name""email",
              "inboundParameterName""email"
            },
            {
              "id""bcfd5d8a-cb92-4267-985d-46131bf95576",
              "name""field_",
              "inboundParameterName""field"
            }
          ],
          "startDate""2018-02-06T16:18:54.930Z",
          "endDate""2018-02-06T16:18:54.930Z",
          "allDay"false,
          "publicEventName""Public event name",
          "timezone""GMT",
          "venueName""venue name",
          "addressLine1""Addr1",
          "addressLine2""Addr2",
          "city""city",
          "state""NY",
          "zipCode""11111",
          "emailOfflineDonations""offline@mail.com",
          "onlineOnlyEvent"true,
          "allowsTeams"true,
          "hasEventLevelFundraisingGoal"true,
          "eventLevelFundraisingGoalValue": 55.5,
          "requireFundraisersToSignWaiver"true,
          "registrations": [
            {
              "name""name",
              "price": 3.3,
              "totalAvailable": 37
            }
          ]
        }
      }

      Petition Form 

      Response Fields

      Generic Fields

      Response

      {
        "id""79170dda-f5f2-4471-8885-d5e0bbdd64a1",
        "timestamp""2018-02-06T16:09:57.543Z",
        "header": {
          "processingTime": 88,
          "serverId""local"
        },
        "payload": {
          "type""PETITION",
          "id""258572e0-701c-4991-ae1c-acfcb7c763e6",
          "name""name",
          "description""description",
          "createDate""2018-02-06T16:09:57.543Z",
          "publishDate""2018-02-06T16:09:57.543Z",
          "modifiedDate""2018-02-06T16:09:57.543Z",
          "status""Published",
          "visibility""Public",
          "pageUrl""https://page/salsalabs.org",
          "widgetScript""<a href=\"https://svm5.test.igniteaction.net/series1form\" target=\"_blank\" style=\"background:rgb(152, 0, 0);padding:10px;margin:10px 0px;text-align:center;text-decoration:none;font-size:12pt;color:#222222;font-family:Arial, Helvetica, sans-serif;display:inline-block;\">Sign Up!</a>",
          "googleAnalytics"true,
          "facebookPixel"false,
          "formFields": [
            {
              "id""4e9549c9-7cf2-4369-b25d-b7dff7264a1c",
              "name""email",
              "inboundParameterName""email"
            },
            {
              "id""47dc654f-33d8-4d28-b2b8-0b99c7ae4f05",
              "name""field_",
              "inboundParameterName""field"
            }
          ]
        }
      }

      Sign-up Form

      Response Fields

      Generic Fields

      Response

      {
        "id""48fb42a3-8bbd-47ee-a731-bb10a3aea822",
        "timestamp""2018-02-06T16:04:26.565Z",
        "header": {
          "processingTime": 88,
          "serverId""local"
        },
        "payload": {
          "type""SUBSCRIBE",
          "id""8e5a51d5-32c0-449d-98ec-9fc80b73795b",
          "name""name",
          "description""description",
          "createDate""2018-02-06T16:04:26.565Z",
          "publishDate""2018-02-06T16:04:26.565Z",
          "modifiedDate""2018-02-06T16:04:26.565Z",
          "status""Published",
          "visibility""Public",
          "pageUrl""https://page/salsalabs.org",
          "widgetScript""<a href=\"https://svm5.test.igniteaction.net/series1form\" target=\"_blank\" style=\"background:rgb(152, 0, 0);padding:10px;margin:10px 0px;text-align:center;text-decoration:none;font-size:12pt;color:#222222;font-family:Arial, Helvetica, sans-serif;display:inline-block;\">Sign Up!</a>",
          "googleAnalytics"true,
          "facebookPixel"false,
          "formFields": [
            {
              "id""cd09740e-6a6e-4344-bbe6-eb19c803f957",
              "name""email",
              "inboundParameterName""email"
            },
            {
              "id""8f571f20-d0e2-4fd6-bf4c-1772ed020d2a",
              "name""field_",
              "inboundParameterName""field"
            }
          ]
        }
      } 

      Targeted Action Form

      Response Fields

      Generic Fields

      Name

      Type

      Description

      includeClickToCall

      Boolean

      click to call enabled: yes/no

      promotionalFacebookMessage

      String

      promotional facebook message

      String will return () for actions executed after July 18, 2018 due to Facebook changes.

      promotionalTwitterMessage

      String

      promotional twitter message 

      String will return () for actions executed after July 18, 2018 due to Facebook changes.

      targetSets

      Array

      Array of target sets - see Target Sets


      Target Sets

      Name

      Type

      Description

      name

      String

      target set name

      description

      String

      target set description

      email

      Object

      Complex type containing following parameters:

      • eligibleTargetsCount - number of targets

      • topic - topic of the email

      • subject - subject of the email

      • message - email body

      • canModifyContentOption - can the supporter make changes to the email body

      twitter

      Object

      Complex type containing following parameters

      • eligibleTargetsCount - number of targets

      • message - suggested Twitter message

      facebook

      Object

      Complex type containing following parameters

      • eligibleTargetsCount - number of targets

      • message - suggested Facebook message

      Object will return () for actions executed after July 18, 2018 due to Facebook changes.

       

      Response

      {
        "id""20da9ebb-072e-40ac-928d-02088c848648",
        "timestamp""2018-02-06T16:09:57.550Z",
        "header": {
          "processingTime": 88,
          "serverId""local"
        },
        "payload": {
          "type""TARGETED_LETTER",
          "id""752b5677-61df-4233-a1fb-9fb7275a7b5c",
          "name""name",
          "description""description",
          "createDate""2018-02-06T16:09:57.550Z",
          "publishDate""2018-02-06T16:09:57.550Z",
          "modifiedDate""2018-02-06T16:09:57.550Z",
          "status""Published",
          "visibility""Public",
          "pageUrl""https://page/salsalabs.org",
          "widgetScript""<a href=\"https://svm5.test.igniteaction.net/series1form\" target=\"_blank\" style=\"background:rgb(152, 0, 0);padding:10px;margin:10px 0px;text-align:center;text-decoration:none;font-size:12pt;color:#222222;font-family:Arial, Helvetica, sans-serif;display:inline-block;\">Sign Up!</a>",
          "googleAnalytics"true,
          "facebookPixel"false,
          "formFields": [
            {
              "id""381aa4ec-fd3f-4f3b-a6a2-25954848355b",
              "name""email",
              "inboundParameterName""email"
            },
            {
              "id""e3d30c39-50e6-4efa-93ca-9b045159dc15",
              "name""field_",
              "inboundParameterName""field"
            }
          ],
          "includeClickToCall"false,
          "targetSets": [
            {
              "name""email",
              "description""desc",
              "email": {
                "eligibleTargetsCount": 1,
                "topic""topic",
                "subject""subj",
                "message""message",
                "canModifyContentOption"true
              },
              "twitter": {
                "eligibleTargetsCount": 2,
                "message""message"
              }
            }
          ],
          "promotionalFacebookMessage""Promo Facebook Message",
          "promotionalTwitterMessage""Promo Twitter Message"
        }
      }

      Ticketed Event Form 

      Response Fields

      Generic Fields

      Name
      Type
      Description

      addressLine1

      String

      address line 1

      addressLine2

      String

      address line 2

      allDay

      Boolean

      all day or not

      city

       String

      city

      endDate

      Date

      end date. ISO_8601 formatted String with a GMT timezone

      publicEventName

      String

      public event name

      startDate

      Date

      start date. ISO_8601 formatted String with a GMT timezone

      state

       String

      state

      tickets

       List

      list of tickets

      name

       String

      ticket name

      price

       Double

      ticket price

       

      Response

      {
        "id""b4cf1495-3363-4732-91e0-5eba7ee30091",
        "timestamp""2018-02-06T16:18:54.913Z",
        "header": {
          "processingTime"88,
          "serverId""local"
        },
        "payload": {
          "type""TICKETED_EVENT",
          "id""60a0e5d0-c446-45fb-85d7-d8bb1da785a0",
          "name""name",
          "description""description",
          "createDate""2018-02-06T16:18:54.913Z",
          "publishDate""2018-02-06T16:18:54.913Z",
          "modifiedDate""2018-02-06T16:18:54.913Z",
          "status""Published",
          "visibility""Public",
          "pageUrl""https://fundraise/salsalabs.org",
          "widgetScript""<a href=\"https://svm5.test.igniteaction.net/frm1form\" target=\"_blank\" style=\"background:rgb(152, 0, 0);padding:10px;margin:10px 0px;text-align:center;text-decoration:none;font-size:12pt;color:#222222;font-family:Arial, Helvetica, sans-serif;display:inline-block;\">Sign Up!</a>",
          "googleAnalytics"true,
          "facebookPixel"false,
          "formFields": [
            {
              "id""7e383adc-9644-4c20-8722-7bbe66d19fc1",
              "name""email",
              "inboundParameterName""email"
            },
            {
              "id""9419cd1d-d902-44bd-a746-63fe49814ad4",
              "name""field_",
              "inboundParameterName""field"
            }
          ],
          "startDate""2018-02-06T16:18:54.913Z",
          "endDate""2018-02-06T16:18:54.913Z",
          "allDay"false,
          "publicEventName""Public event name",
          "timezone""GMT",
          "venueName""venue name",
          "addressLine1""Addr1",
          "addressLine2""Addr2",
          "city""city",
          "state""NY",
          "zipCode""11111",
          "tickets": [
            {
              "name""name",
              "price"5.5
            }
          ]
        }
      }
      Was this article helpful?
      0 out of 0 found this helpful
      Have more questions? Submit a request

      Comments

      0 comments

      Please sign in to leave a comment.