Dreamhost icon

Dreamhost

Get data from Dreamhost API

Overview

The node integrates with the Dreamhost API to post announcements to an Announcement List. It allows users to send messages (either plain text or HTML) to a specified subscriber list managed within Dreamhost's panel. This is useful for automating newsletter distributions, updates, or any broadcast communication to a group of subscribers.

Typical use cases include:

  • Sending scheduled newsletters or announcements to mailing lists.
  • Broadcasting updates or alerts to subscribers automatically.
  • Integrating announcement sending into larger workflows, such as after content creation or event triggers.

Properties

Name Meaning
List Name The name of the subscriber list as it appears in the Dreamhost Announce Lists page (e.g., "testlist" if the full list is testlist@example.com).
Domain The domain part of the subscriber list email address (e.g., "example.com" if the full list is testlist@example.com).
Subject The subject line of the announcement message being sent.
Message The body text of the announcement message. Can contain HTML code if the message type is set to HTML.
From Name The sender's name and email as configured in the Announcement List settings (e.g., "My Newsletter newsletter@example.com").
Additional Fields A collection of optional fields:
- Schedule Message: Date/time to schedule the sending of the announcement.
- Encoding: Character set encoding of the message (e.g., "utf-8").
- Type: Format of the message, either "Text" or "HTML".
- Allow Duplicate: Boolean flag indicating whether duplicate messages are allowed to be sent.
Output Format The format in which the response data should be returned. Options include: HTML, JSON, Perl, PHP, Tab, XML, YAML.

Output

The node outputs the response from the Dreamhost API call related to posting the announcement. The output is structured according to the selected "Output Format" property and typically includes confirmation details about the posted announcement or error information if the request failed.

If binary data were involved (not indicated here), it would represent attachments or similar content, but this node focuses on textual announcement data.

Dependencies

  • Requires an active Dreamhost API key credential configured in n8n for authentication.
  • Depends on the Dreamhost API endpoint https://api.dreamhost.com to perform announcement posting.
  • The node uses HTTP GET requests with query string parameters to interact with the API.

Troubleshooting

  • Missing Required Fields: Ensure that all required properties like List Name, Domain, Message, and From Name are provided; otherwise, the API will reject the request.
  • Invalid Scheduling Date: If scheduling is used, verify the date/time format is correct ISO string without timezone offset.
  • Duplicate Messages Not Allowed: If duplicates are disallowed but the same message is sent twice, the API may return an error or ignore the second message.
  • Authentication Errors: Confirm that the Dreamhost API key credential is valid and has sufficient permissions.
  • API Response Errors: Check the output format and API response for error messages indicating issues such as invalid list names or domain mismatches.

Links and References

Discussion