Webhooks

Webhooks allow you to receive an HTTP POST when certain actions are performed within your account. This is useful if you need to build custom automation with code.

Add a webhook

To add webhook to your account, navigate to Settings > Integrations and click "Add a webhook":

Input the endpoint URL and select the events you wish to receive:

Testing webhooks

If you'd like to test out receiving payloads, try out RequestBin.

Consuming webhooks

As soon as you register a webhook, we will begin sending near real-time payloads to the URL when various events occur. Your endpoint should respond with an HTTP 200 OK status code as soon as you receive a payload from Paced Email. We recommend using a background queue to process incoming payloads to ensure your service responds speedily.

We raise exceptions for all HTTP status codes that indicate some sort of error. However, we'll retry the webhook delivery on an exponential backoff basis. The HTTP status code 410 Gone is an exception. Whenever your endpoint returns a 410 error, we will consider it no longer valid and remove it from your account.

Example payload

Here is an example JSON payload for the inbox.created event:

{
  "inbox": {
    "id": "inbox_Xy0jn6iWOrcQuwkO4g2Rlw55",
    "alias": "johndoe@daily.paced.email",
    "periodicity": "daily",
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit",
    "bypass_first_message": false,
    "rules_count": 1,
    "deleted_at": null,
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z",
    "account": {
      "id": "account_bE6zkNZo71qZSEQ7X01Ypglr",
      "name": "Personal",
      "subscribed": true,
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    },
    "domain": null,
    "username": {
      "id": "username_p4yglOyRZ6xmF54Hv1e9WdN4",
      "username": "johndoe",
      "primary": true
    }
  },
  "event_name": "inbox.created"
}

Available event types

  • digest.created
  • digest.updated
  • digest.deleted
  • domain.created
  • domain.updated
  • domain.deleted
  • inbox.created
  • inbox.updated
  • inbox.deleted
  • username.created
  • username.updated
  • username.deleted

Still need help? Contact Us Contact Us