Webhooks

Introduction

Webhooks let you send real-time data from GetResponse to any other platform you're using. You can get notified about contact-related events: new subscriptions, unsubscribes, link clicks, or message opens.

In your GetResponse account, pick the events to notify you of, and enter a webhook URL. This way, we'll know when we need to notify you and where to send the data

Requirements

Here are a few things to keep in mind when setting up and working with webhooks:

  1. Your endpoint needs to be able to process HTTPS requests. So, your app needs to use HTTPS. Make sure your server has a valid SSL certificate configured and installed.
  2. Your endpoint must process the request within 5 seconds. If we don't receive a response, the webhook will timeout, and the connection will close.
  3. To confirm a webhook is received, your endpoint should return one of the following 2xx HTTP status codes:
    • 200 OK
    • 201 Created
    • 202 Accepted
    • 204 No Content
  4. The response body must contain JSON: {"status": "ok"} Without it, the request will be retried despite a 2xx status code.

Authentication

To verify a webhook request comes from GetResponse, you can add your own query string parameter at the end of your webhook URL. This will allow you to accept only the requests containing the parameter.

Your URL may look like this: https://www.example-webhook-url.com/?secret=xyz

Note: The parameter value and the name can be anything you want.

Retry policy

If the webhook request fails because of a network or server issue, we will retry 3 more times at increasing intervals.

Requests that are retried

We retry requests for the following reasons:

  • 2xx (if there's no required response body)
  • 429 (Too Many Requests )
  • all 5xx
  • Timeout (no response received within 5 seconds)

Requests that are NOT retried

We don't retry requests if your endpoint returns any for the following status codes:

  • 1xx
  • 3xx (redirects)
  • 4xx (except 429)

Webhooks events

You can configure your webhooks to send information about the following events:

  • Message opened - get notified every time a contact opens an email
  • Link clicked - get notified every time a contact clicks a link in an email
  • Contact subscribed - get notified when a contact is added. This event is not triggered by imports
  • Contact unsubscribed - get notified when a contact unsubscribed via unsubscribe link in an email

To see payload details please navigate to Webhook payload details