My Developer Account

Add-ons Insertion Points

The following "insertion points" are currently available for your add-on to affect the Planning Center user interface:

people.list.send_message

Opens a modal with your add-on content.

People list send message insertion point

  • args

    • listId: unique ID number of the list
    • listName: name or description of list
    • profileCollectionId: unique ID number of a profile collection containing the selected people, or everyone in the list when no one is selected. Fetch it, with its people, from /people/v2/profile_collections/{profileCollectionId}?include=people using authenticatedFetch. People creates a new collection each time the modal opens, so don't store the ID for reuse on a later open
    • currentPersonId: current person (user) ID
    • currentOrganizationId: current organization (tenant) ID
    • closeModal: a function that closes the add-on modal when invoked

people.list.send_email

Opens a modal with your add-on content. People has not finished rolling out this insertion point, so an extension registered here may not be visible to every organization yet.

  • args

    • listId: unique ID number of the list
    • listName: name or description of list
    • profileCollectionId: unique ID number of a profile collection containing the selected people, or everyone in the list when no one is selected. Fetch it, with its people, from /people/v2/profile_collections/{profileCollectionId}?include=people using authenticatedFetch. People creates a new collection each time the modal opens, so don't store the ID for reuse on a later open
    • currentPersonId: current person (user) ID
    • currentOrganizationId: current organization (tenant) ID
    • closeModal: a function that closes the add-on modal when invoked

people.dashboards.background_checks.new

Opens a modal to start a background check from the background check dashboard.

  • args

    • currentPersonId: current person (user) ID
    • currentOrganizationId: current organization (tenant) ID
    • closeModal: a function that closes the add-on modal when invoked

people.profile.background_checks.new

Opens a modal to start a background check from a person's profile page.

  • args

    • personId: ID of person profile being viewed
    • currentPersonId: current person (user) ID
    • currentOrganizationId: current organization (tenant) ID
    • closeModal: a function that closes the add-on modal when invoked