Import subscribers via CSV

If you import subscribers that already exist, their subscription settings (the components they're subscribed to) will be overwritten with the most recent settings - we do not "skip" existing subscribers as duplicates.

  1. Navigate to Subscribers from the left sidebar.

  2. Click the Options drop-down menu from the top right of the Subscribers page.

  3. Click Import subscribers.

  4. Download the import template from the dialogue that appears.

    1. We strongly recommend that you download and use the template CSV (available from the import subscribers screen shown below). The data in your CSV must be in a specific format and copy/pasting your data into the template will help ensure you don't encounter any errors.

  5. Use the import template CSV file to enter subscriber information.

  6. Revisit the import subscribers dialogue screen when you're done to choose and upload your CSV file.

  7. Click Import subscribers.

The modal for importing subscribers with the file uploader

Slack subscribers can’t be imported via CSV.

Required fields for Email subscribers

Type

The first column should contain the word "email" so that we know what type of subscriber you are trying to add.

Email address

The next column should contain the email address of the person that you want to receive email notifications.

Skip confirmation notification

An active page can enter "yes" or "no" into this field in order to skip or send confirmation request when adding subscriptions. This is no longer applicable for Email invites where confirmation is now required.

Required fields For SMS subscribers

Type

The first column should contain the word "sms" so that we know what type of subscriber you are trying to add.

Number

The next column should contain the phone number of the person you want to receive SMS notifications. This field SHOULD include the zip code but SHOULD NOT include the country code.

Please do not include any spaces or dashes in this field.

Country code

The next column should contain the associated two letter country code (e.g. "US" and not "+1") that goes with the phone number.

Required fields for webhook subscribers

Type

The first column should contain the word "webhook" so that we know what type of subscriber you are trying to add.

Webhook URL

The next column should contain the webhook url that you want the webhook data to be sent to.

Email address

The next column should contain an email address that we will send a message to in the event that the webhook starts failing.

Component codes field (optional)

The component codes column should be a semi-colon separated list of component codes that you want the subscriber to receive notifications for. This column should be ignored unless you have component subscriptions enabled.

To find the specific code for each component, the easiest thing to do is to use the developer tools to inspect the DOM on the Components page. The code will appear in the data-component-code attribute for each component row.

The components screen with the page inspector open to find component codes

Debugging errors

Missing a required field

If any subscriber you are trying to upload is missing a required field (see above for which fields are required for each subscriber type), the importer will throw an error.

Invalid Email address

If the email address validation fails when trying to add an Email or Webhook Subscriber, the importer will throw an error. Make sure email addresses are valid before adding them.

Invalid phone number or country code

If a phone number or country code validation fails when trying to add an SMS subscriber, the importer will throw an error. Make sure phone numbers and country codes are correct before trying to add them.

Data in CSV is not given in the correct order

The data in the CSV must match that of the downloadable template file.

SMS users are still getting confirmations

Many US phone numbers route through the short code STSPG to best guarantee delivery. In this case, users cannot opt out of confirmation, and they MUST text back 'yes' to the opt in to get any incident updates.

Still need help?

The Atlassian Community is here for you.