Webhooks

CleverPush provides certain webhook events that can be used to receive event data live from CleverPush to your own systems.

If a webhook call fails, CleverPush will retry it up to 8 times with 2 minutes initial delay and exponential backoff.

Example payloads:

Opt-In

{
  "type": "optIn",
  "subscription": {
    "_id": "SUBSCRIPTION_ID",
    "createdAt": "2024-03-04T09:50:51.375Z",
    "syncedAt": "2024-03-04T09:50:51.375Z",
    "channel": "CHANNEL_ID",
    "browserType": "SDK",
    "platformName": "iOS",
    "language": "en",
    "country": "DE",
    "timezone": "Europe/Berlin"
  },
  "channel": {
    "_id": "CHANNEL_ID"
  }
}

Opt-Out

{
  "type": "optOut",
  "subscription": {
    "_id": "SUBSCRIPTION_ID",
    "createdAt": "2024-03-04T09:50:51.375Z",
    "syncedAt": "2024-03-04T09:50:51.375Z",
    "browserType": "SDK",
    "platformName": "iOS",
    "topics": []
  },
  "channel": {
    "_id": "CHANNEL_ID"
  }
}

Message Delivery

{
  "type": "delivery",
  "date": "2024-03-04T10:09:40.124Z",
  "subscription": {
    "_id": "SUBSCRIPTION_ID"
  },
  "notification": {
    "_id": "NOTIFICATION_ID",
    "feedGuid": [
      "https://www.cnn.com/123456"
    ]
  },
  "channel": {
    "_id": "CHANNEL_ID"
  }
}

Message Click

{
  "type": "click",
  "date": "2024-03-04T10:10:40.136Z",
  "subscription": {
    "_id": "SUBSCRIPTION_ID"
  },
  "notification": {
    "_id": "NOTIFICATION_ID",
    "feedGuid": [
      "https://www.cnn.com/123456"
    ]
  },
  "channel": {
    "_id": "CHANNEL_ID"
  }
}

Topics Updated

{
  "type": "updateTopics",
  "subscription": {
    "_id": "SUBSCRIPTION_ID",
    "createdAt": "2024-03-04T10:15:14.778Z",
    "syncedAt": "2024-03-04T10:15:14.778Z",
    "browserType": "SDK",
    "platformName": "iOS",
    "language": "en",
    "country": "DE",
    "timezone": "Europe/Berlin",
    "topics": ["TOPIC_ID_1"]
  },
  "channel": {
    "_id": "CHANNEL_ID"
  }
}

Topic Added

{
  "type": "topicAdded",
  "subscription": {
    "_id": "SUBSCRIPTION_ID",
    "createdAt": "2024-03-04T10:15:14.778Z",
    "syncedAt": "2024-03-04T10:19:27.824Z",
    "browserType": "SDK",
    "platformName": "iOS",
    "language": "en",
    "country": "DE",
    "timezone": "Europe/Berlin",
    "topics": ["TOPIC_ID_1"]
  },
  "channel": {
    "_id": "CHANNEL_ID"
  },
  "newTopicsIds": [
    "TOPIC_ID_2"
  ]
}

Attributes Updated

{
  "type": "attributeUpdate",
  "subscription": {
    "_id": "SUBSCRIPTION_ID",
    "createdAt": "2024-03-04T10:15:14.778Z",
    "syncedAt": "2024-03-04T10:19:27.824Z",
    "browserType": "Chrome",
    "platformName": "Mac OS",
    "language": "en",
    "country": "DE",
    "timezone": "Europe/Berlin",
    "topics": ["TOPIC_ID_1",],
    "customAttributes": {
      "user_id": "test123"
    }
  },
  "channel": {
    "_id": "CHANNEL_ID"
  }
}