Improve description of endpoint configuration

Created on 19 April 2024, 8 months ago
Updated 21 April 2024, 8 months ago

Problem/Motivation

The module setting for GovDelivery API Endpoint is confusing
- As a new GovDelivery user, I wasn't sure what I was supposed to put in the "GovDelivery API Endpoint" field. Just the base URL from https://support.granicus.com/s/article/Getting-Started-API?language=en_US, or our account code, or a fully qualified URL, etc. I eventually figured it out, but an example or suggestion of where to find the API enpoint URL would be very helpful.

The GovDelivery Bulletin APIs are documented at https://support.granicus.com/s/article-group/a8C4w000000XcOnEAK/bulletin.... I ended up using a fully qualified GovDelivery API URL like one of the following:

Staging
https://stage-api.govdelivery.com/api/account/ACCOUNT_CODE/bulletins/sen... (to send immediately)
https://stage-api.govdelivery.com/api/account/ACCOUNT_CODE/bulletins.xml (to create a draft bulletin)

Production
https://api.govdelivery.com/api/account/ACCOUNT_CODE/bulletins/send_now (to send immediately)
https://api.govdelivery.com/api/account/ACCOUNT_CODE/bulletins.xml (to create a draft bulletin)

Your ACCOUNT_CODE can be found via the GovDelivery administrative interface. (Look in the URL)

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

✨ Feature request
Status

Fixed

Version

1.0

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States swirt Florida

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024