Email Notifications

The MetOcean API provides an optional email notification system to keep you informed about the status of your asynchronous data processing tasks.

Enabling Email Notifications

To receive email notifications, you need to include the receive_mail parameter in your API request to the /MetOcean/async endpoint:

{
    "points": [...],
    "variables": [...],
    "receive_mail": true,
    "email": "your-email@example.com"  // Optional - defaults to user account email
}

If the email parameter is not provided, notifications will be sent to the email address associated with your user account.

Types of Notifications

Task Started Notification

When your task begins processing, you'll receive an email notification that includes: - Task ID for tracking purposes - Start time (UTC) - Number of points being processed - Requested variables - Custom task name (if provided)

Here's the information included in a task start notification:

We are pleased to inform you that your MetOcean data processing task has been started successfully.

Task details
• Task ID: 46e2e56e-0551-473f-9033-c88b8f63e303
• Start time: 2025-03-11 14:46:13 (UTC)
• Points: 5000
• Variables: wind, wave, current
• Task name: ship1-leg1

You will receive an email notification when the processing is completed.

If you have any questions or need assistance, please contact our support team.

Best regards,
The Amphitrite team

Task Completion Notification

When your task completes successfully, you'll receive another email with the results attached as a JSON file. The email includes: - Task ID for reference - Start and completion times - Total processing duration - Summary of the processed data - JSON attachment with the full results

Here's the information included in a task completion notification:

We are pleased to inform you that your MetOcean data processing task has been completed successfully.

Task details
• Task ID: 46e2e56e-0551-473f-9033-c88b8f63e303
• Start time: 2025-03-11 14:46:13 (UTC)
• Completion time: 2025-03-11 14:49:42 (UTC)
• Total duration: 3 minutes 29 seconds

Summary of results
Here is an overview of the processed data:
• Number of points: 5000
• Processed variables: wind, wave, current
• Period: 2025-01-15 to 2025-02-15

You can use these results for your analyses or visualize them in your application.

If you have any questions about the results or if you want to get more information, please contact our support team.

Best regards,
The Amphitrite team

Benefits of Email Notifications

Email notifications are particularly useful for:

  1. Long-running tasks: Get notified when large data processing jobs are complete
  2. Asynchronous workflows: Submit requests and continue working without constantly checking the API
  3. Team collaboration: Share task notifications with colleagues

Email Delivery

Our system attempts to deliver emails immediately, but delivery times may vary depending on your email provider. If you don't receive an expected notification:

  1. Check your spam or junk folder
  2. Verify that your email address is correct
  3. Use the API to check your task status directly

For more information on checking task status programmatically, see Request Processing Modes.