Skip to content

CON-369: Update Petitions and Events API with new social media message settings #189

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.

Sign up for GitHub

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
ehimen-io merged 1 commit into from
Jan 21, 2026
Merged

CON-369: Update Petitions and Events API with new social media message settings #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 43 additions & 3 deletions source/includes/authenticated_api/_events.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,17 @@ The authenticated REST API endpoints for events only deal with events created in
"slug": "repair-the-yellow-brick-road-1",
"url": "https://demo.controlshiftlabs.com/petitions/repair-the-yellow-brick-road-1"
},
"labels": ["oz-organizer-help"]
"labels": ["oz-organizer-help"],
"bluesky_share_message": "Join us at this event!",
"facebook_share_description": "Come deliver the petition with us",
"facebook_share_title": "Deliver the Petition to the Wizard",
"meta_title": "Deliver the Petition to the Wizard - Event",
"meta_description": "Join us as we travel to the Emerald City",
"twitter_share_description": "Join us in the Emerald City!",
"twitter_share_message": "Attending this event to deliver our petition",
"twitter_share_title": "Deliver the Petition to the Wizard",
"web_share_api_share_message": "Check out this event in the Emerald City",
"whatsapp_share_message": "I'm attending this event to deliver the petition. Join me!"
},
...
],
Expand Down Expand Up @@ -140,7 +150,17 @@ The response includes all the same data as the single-event endpoint for each ev
"slug": "repair-the-yellow-brick-road-1",
"url": "https://demo.controlshiftlabs.com/petitions/repair-the-yellow-brick-road-1"
},
"labels": ["oz-organizer-help"]
"labels": ["oz-organizer-help"],
"bluesky_share_message": "Join us at this event!",
"facebook_share_description": "Come deliver the petition with us",
"facebook_share_title": "Deliver the Petition to the Wizard",
"meta_title": "Deliver the Petition to the Wizard - Event",
"meta_description": "Join us as we travel to the Emerald City",
"twitter_share_description": "Join us in the Emerald City!",
"twitter_share_message": "Attending this event to deliver our petition",
"twitter_share_title": "Deliver the Petition to the Wizard",
"web_share_api_share_message": "Check out this event in the Emerald City",
"whatsapp_share_message": "I'm attending this event to deliver the petition. Join me!"
}
}
```
Expand Down Expand Up @@ -260,7 +280,17 @@ the event `slug` is `chapter-meeting-1`.
"sharing_disabled": false,
"web_conference_url": null,
"mentor": null,
"reviewer": null
"reviewer": null,
"bluesky_share_message": null,
"facebook_share_description": null,
"facebook_share_title": null,
"meta_title": null,
"meta_description": null,
"twitter_share_description": null,
"twitter_share_message": null,
"twitter_share_title": null,
"web_share_api_share_message": null,
"whatsapp_share_message": null
}
}
```
Expand Down Expand Up @@ -300,20 +330,30 @@ The fields that can be changed this way are:

Field | Type | Description
------|------|------------
bluesky_share_message | String | Custom message used when sharing the event on Bluesky
campaigner_contactable | Boolean | Whether members of the public can contact the event host via the public event page
description | String | Description of the event
event_host_name_override | String | Name to display for the event host on the event page. Set to `null` to use the name from the event host's user account.
extra_location_info | String | Additional non-address information about the event's location, e.g. "7th floor" or "Park in the back parking lot"
facebook_share_description | String | Custom description used when sharing the event on Facebook
facebook_share_title | String | Custom title used when sharing the event on Facebook
forum_enabled | Boolean | Enables or disables the discussion forum feature for the event's attendees
hidden_address | Boolean | Indicates that the event's address is private. The city/locality will be shown on the web, but the full address will only be provided to members who RSVP to the event.
hide_recent_attendees | Boolean | Do not display the names of people who recently RSVPed in the post-RSVP sharing prompt.
host_address | String | The mailing address of the event host. May be used to mail event materials.
location_venue | String | Venue name. Only relevant for in-person events.
max_attendees_count | Integer | Limit on how many people, besides the host, may sign up for this event. Set to `null` for no limit.
meta_description | String | Custom meta description for the event page (used for SEO and social media previews)
meta_title | String | Custom meta title for the event page (used for SEO and social media previews)
redirect_to | String | If set, visitors to the event page will be redirected to this URL
sharing_disabled | Boolean | Turns off the social sharing prompts for the event
title | String | Event title
twitter_share_description | String | Custom description used when sharing the event on Twitter/X
twitter_share_message | String | Custom message used when sharing the event on Twitter/X
twitter_share_title | String | Custom title used when sharing the event on Twitter/X
web_conference_url | String | Video call or web conference tool URL for attendees to access the event
web_share_api_share_message | String | Custom message used when sharing the event via the Web Share API
whatsapp_share_message | String | Custom message used when sharing the event on WhatsApp

<div></div>

Expand Down
34 changes: 32 additions & 2 deletions source/includes/authenticated_api/_petitions.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,17 @@ Petition are pieces of content that can be signed by members.
"slug": "boats",
"name": "Boats"
}
]
],
"bluesky_share_message": "Join us in supporting this petition!",
"facebook_share_description": "Help us stop the taxation of tea",
"facebook_share_title": "No Taxes on Tea",
"meta_title": "No Taxes on Tea - ControlShift",
"meta_description": "Sign our petition to stop tea taxation",
"twitter_share_description": "Stop taxing our tea!",
"twitter_share_message": "Sign this petition to end tea taxes",
"twitter_share_title": "No Taxes on Tea",
"web_share_api_share_message": "Check out this petition about tea taxes",
"whatsapp_share_message": "I just signed a petition about tea taxes. Join me!"
}
}
```
Expand Down Expand Up @@ -325,7 +335,17 @@ Get a paginated list of all petitions, including ones that are unlaunched or oth
"slug": "end-colonialism-now",
"title": "End Colonialism"
}
]
],
"bluesky_share_message": null,
"facebook_share_description": null,
"facebook_share_title": null,
"meta_title": null,
"meta_description": null,
"twitter_share_description": null,
"twitter_share_message": null,
"twitter_share_title": null,
"web_share_api_share_message": null,
"whatsapp_share_message": null
}
}
```
Expand Down Expand Up @@ -398,6 +418,7 @@ Field | Type | Description
------|------|------------
admin_events_status | String | Whether the petition creator can create events associated with the petition. Must be one of "on" (events can be created), "off" (events cannot be created), or "auto" (use the default setting based on moderation status and number of signatures).
alias | String | Used for the petition's short URL. Setting `alias` to "foo" will result in a short URL of /p/foo
bluesky_share_message | String | Custom message used when sharing the petition on Bluesky
campaigner_contactable | Boolean | Whether members of the public can contact the petition creator via the public petition page
can_download_signers | Boolean | Whether the petition creator can download information about petition signers
categories_locked | Boolean | Petition creator cannot change which categories the petition is in
Expand All @@ -408,18 +429,27 @@ external_facebook_page | String | URL of a Facebook page associated with the pet
external_facebook_page_locked | Boolean | Petition creator cannot change the Facebook page URL
external_site | String | URL of a non-ControlShift page associated with the petition
external_site_locked | Boolean | Petition creator cannot change the external site URL
facebook_share_description | String | Custom description used when sharing the petition on Facebook
facebook_share_title | String | Custom title used when sharing the petition on Facebook
hide_petition_creator | Boolean | Do not display the petition creator's name or profile picture on the petition page
hide_recent_signers | Boolean | Do not display the list of recent signers on the petition page
hide_signature_form | Boolean | Turn off the form that allows people to sign the petition via the petition page
meta_description | String | Custom meta description for the petition page (used for SEO and social media previews)
meta_title | String | Custom meta title for the petition page (used for SEO and social media previews)
partnerships | Array | List of partnerships this petition should be associated with, formatted like `[{"slug": "foo"}, {"slug": "bar"}]`. If the petition was associated with any partnerships that are not included in the list, it will be removed from those partnerships.
petition_creator_name_override | String | Name to display for the petition creator on the petition page. Set to `null` to use the name from the petition creator's user account.
redirect_to | String | If set, visitors to the petition page will be redirected to this URL
show_progress_bar | Boolean | Whether to show the signature progress bar on the petition page
signature_count_add_amount | Integer | If set, the displayed signature total on the petition page will be this much higher than the actual number of signatures recorded by the platform. This is usually used to reflect signatures that were gathered elsewhere and cannot be added to the platform, or signers whose data has been anonymized. A negative number can be specified to subtract from the total.
title | String | Petition title
title_locked | Boolean | Petition creator cannot change the title
twitter_share_description | String | Custom description used when sharing the petition on Twitter/X
twitter_share_message | String | Custom message used when sharing the petition on Twitter/X
twitter_share_title | String | Custom title used when sharing the petition on Twitter/X
web_share_api_share_message | String | Custom message used when sharing the petition via the Web Share API
what | String | Petition text in HTML format
what_locked | Boolean | Petition creator cannot change the "what" field
whatsapp_share_message | String | Custom message used when sharing the petition on WhatsApp
who | String | Name of the person this petition is targeting. Petitions associated with a decision maker will not necessarily use this setting.
who_locked | Boolean | Petition creator cannot change the "who" field
why | String | "Why is this important?" text in HTML format
Expand Down