Upcoming API Transmission Endpoint changes

[laryn]

I got this info in an email from Sparkpost -- do these upcoming changes affect this extension?

https://www.sparkpost.com/blog/upcoming-api-transmission-endpoint-changes

[laryn]

FYI, in the Drupal module they say "Don't worry about it."

https://www.drupal.org/node/2920893

[danielstrum]

I would also like to know the answer to this question.

[freeform-sg]

This is not a big deal for the Drupal module as they're not doing much with bounces. In the case of CiviCRM, however, since the API update, we are seeing that the bounce callback not working means that records are not getting updated to indicate a bad email address, which means repetitive mail going to bad addresses unless one is manually reviewing the bounce report in Sparkpost and making the necessarycontact updates.

[nganivet]

I have already sunk more than 50 hours of volunteer time developing this extension. I am asking for a very modest $40 contribution for using this extension - but have received less than one handful of donations so far Anyone willing to finance investigation and fix for this issue? Email me at [email protected]. Thanks.

[herbdool]

@nganivet it's not clear why you closed this issue. I've reviewed the Transmission API and it seems that there is a potentially small tweak that needs to be made to the error response. I can probably provide a PR. It would look like this:

diff --git a/CRM/Sparkpost.php b/CRM/Sparkpost.php
index cfeda33..13e501e 100644
--- a/CRM/Sparkpost.php
+++ b/CRM/Sparkpost.php
@@ -151,11 +151,11 @@ class CRM_Sparkpost {
           case 420 :
             throw new Exception("Sparkpost error: Sending limits exceeded. Check your limits in the Sparkpost console.", CRM_Sparkpost::FALLBACK);
         }
-        //If we don't get an error code OR description, this error is a 404 response for checking the suppression list for an email that isn't on it. See https://developers.sparkpost.com/api/suppression-list/#suppression-list-get-retrieve-a-suppression
+        //If we don't get an error code OR message, this error is a 404 response for checking the suppression list for an email that isn't on it. See https://developers.sparkpost.com/api/suppression-list/#suppression-list-get-retrieve-a-suppression
         //In that case it's an expected workflow and we don't want to return a blank error response to the user just for checking
-        if (property_exists($error, 'code') && property_exists($error, 'description')) {
+        if (property_exists($error, 'code') && property_exists($error, 'message')) {
           // Don't have specifics, so throw a generic exception
-          throw new Exception("Sparkpost error: HTTP return code $curl_info[http_code], Sparkpost error code $error->code ($error->message: $error->description). Check https://support.sparkpost.com/customer/en/portal/articles/2140916-extended-error-codes for interpretation.");
+          throw new Exception("Sparkpost error: HTTP return code $curl_info[http_code], Sparkpost error code $error->code ($error->message). Check https://support.sparkpost.com/customer/en/portal/articles/2140916-extended-error-codes for interpretation.");
         }
       }
     }

This might be why an error message says: "Resource could not be found: " where there's nothing after the colon.

Sparkpost error: HTTP return code 404, Sparkpost error code (Resource could not be found: ). Check https://support.sparkpost.com/customer/en/portal/articles/2140916-extended-error-codes for interpretation.

[nganivet]

@herbdool I have merged this pull request before closing the issue, so do not understand your comment. Maybe you could rephrase?

Merge: f1685df

[herbdool]

I see. You didn't mention that previously in this thread so it wasn't clear. From your other message it seemed as if you were stopping all work on this.

The merged PR still refers to $error->description but from what I understand of the API change that seems to be merged into $error->message. So maybe the format should be updated a bit more?

[nganivet]

@herbdool I will let you "update the format" to whatever is necessary and create another PR. Thanks.

[herbdool]

From their blog post "The description field from Transmission API error response bodies will be removed, with the content from the description field moving to the message field." (https://www.sparkpost.com/blog/error-handling-transmissions-api/). I created a PR #83 to address that one change.

[herbdool]

@nganivet thanks for merging