All webhooks share the following:
- All webhooks provide data in a JSON format
- All webhooks are sent using the HTTP
POST
method
- All
href
properties link to resource details in GetResponse APIv3
- All IDs can be used with GetResponse APIv3
- Each payload contains the following fields:
type
- event type
account
- information about the account
event
- information about the event
Each request will have the following headers:
Content-Type: application/json
X-Webhook-Type: contact_removed_link
X-Webhook-ID: 9b287712-80b9-4aba-ad5e-df31929dad75
X-Request-ID: cf3c768a-3465-4a6d-9ad9-ddae2705f526
|
Content-Type - Information about content type application/json
X-Webhook-Type - Type of event. Same as type field from the payload
X-Webhook-ID - UUID of webhook (unique per event, same for first request and retries)
X-Request-ID - UUID of request (unique per request)
|
Webhook types
Message opened
Get notified every time a contact opens an email
Payload example |
Description |
{
"type": "contact_opened_message",
"contact": {
"contactId": "abc123",
"email": "example@example.com",
"name": "Friend",
"campaign": {
"campaignId": "bcd234",
"name": "my_first_campaign",
"href": "https://api.getresponse.com/v3/campaigns/bcd234"
},
"href": "https://api.getresponse.com/v3/contacts/abc123"
},
"message": {
"resourceType": "autoresponders",
"resourceId": "cde345",
"name": "my_first_newsletter",
"subject": "My First Newsletter",
"href": "https://api.getresponse.com/v3/autoresponders/cde345"
},
"account": {
"accountId": "def456"
},
"event": {
"occurredAt": "2021-04-27T12:56:00+00:00"
}
}
|
|
Link clicked
Get notified every time a contact clicks a link in an email
Payload example |
Description |
{
"type": "contact_clicked_message_link",
"contact": {
"contactId": "abc123",
"email": "example@example.com",
"name": "Friend",
"campaign": {
"campaignId": "bcd234",
"name": "my_first_campaign",
"href": "https://api.getresponse.com/v3/campaigns/bcd234"
},
"href": "https://api.getresponse.com/v3/contacts/abc123"
},
"message": {
"resourceType": "autoresponders",
"resourceId": "cde345",
"name": "my_first_newsletter",
"subject": "My First Newsletter",
"href": "https://api.getresponse.com/v3/autoresponders/cde345"
},
"clickTrack": {
"clickTrackId": "xyz789",
"name": "Some link",
"url": "http://example.com",
"href": "https://api.getresponse.com/v3/click-tracks/xyz789"
},
"account": {
"accountId": "def456"
},
"event": {
"occurredAt": "2021-04-27T12:56:00+00:00"
}
}
|
type - Webhook event type - contact_clicked_message_link
contact - Contact who clicked on the message link
contactId - Contact ID
email - Contact email address
name - Name of the contact nullable
campaign - Campaign (List) a contact is in
campaignId - Campaign (list) ID
name - Campaign (list) name
href - Link to campaign (list) details
href - Link to contact details
message - Message (Newsletter, Autoresponder, or RSS Newsletter) that contains the link clicked
resourceType - Type of the message (autoresponders , newsletters , rssNewsletters )
resourceId - ID of the message
name - Name of the message
subject - Subject of the message
href - Link to the message details
clickTrack - Clicked link
clickTrackId - ID of the link
name - Name of the link
url - URL of the link
href - Link to the details of the link clicked
account - Information about the account
event
|
SMS link clickedGetResponse MAXAdd-on required
Get notified every time a contact clicks a link in a text message (SMS)
Payload example |
Description |
{
"type": "contact_clicked_sms_link",
"contact": {
"contactId": "abc123",
"email": "example@example.com",
"name": "Friend",
"campaign": {
"campaignId": "bcd234",
"name": "my_first_campaign",
"href": "https://api.getresponse.com/v3/campaigns/bcd234"
},
"phoneNumber": {
"customFieldId": "exdqz",
"href": "https://api.getresponse.com/v3/custom-fields/exdqz"
},
"href": "https://api.getresponse.com/v3/contacts/abc123"
},
"sms": {
"smsId": "cde345",
"name": "my_first_sms",
"href": "https://api.getresponse.com/v3/sms/cde345"
},
"clickTrack": {
"clickTrackId": "xyz789",
"name": "Some link",
"url": "http://example.com",
"href": "https://api.getresponse.com/v3/click-tracks/xyz789"
},
"account": {
"accountId": "def456"
},
"event": {
"occurredAt": "2021-04-27T12:56:00+00:00"
}
}
|
type - Webhook event type - contact_clicked_sms_link
contact - Contact who clicked a link in an SMS
contactId - Contact ID
email - Contact email address
name - Name of the contact nullable
campaign - Campaign (List) a contact is in
campaignId - Campaign (list) ID
name - Campaign (list) name
href - Link to campaign (list) details
phoneNumber - Contact phone number custom field
customFieldId - Phone custom field ID
href - Link to phone custom field
href - Link to contact details
sms - SMS (SMS) that contains the link clicked
smsId - ID of the SMS
name - Name of the SMS
href - Link to the SMS details
clickTrack - Clicked link
clickTrackId - ID of the link
name - Name of the link
url - URL of the link
href - Link to the details of the link clicked
account - Information about the account
event
|
Get notified when a contact is added. This event is NOT triggered by imports.
Payload example |
Description |
{
"type": "contact_added",
"contact": {
"contactId": "abc123",
"email": "example@example.com",
"name": "Friend",
"campaign": {
"campaignId": "bcd234",
"name": "my_first_campaign",
"href": "https://api.getresponse.com/v3/campaigns/bcd234"
},
"ip": "1.2.3.4",
"origin": "api",
"href": "https://api.getresponse.com/v3/contacts/abc123"
},
"account": {
"accountId": "def456"
},
"event": {
"occurredAt": "2021-04-27T12:56:00+00:00"
}
}
|
type - Webhook event type - contact_added
contact - Contact added
contactId - ID of added contact
email - Email address of added contact
name - Name of added contact nullable
campaign - Campaign (List) the contact is added to
campaignId - ID of campaign (list) the contact is added to
name - Name of campaign (list) the contact is added to
href - Link to campaign (list) details
ip - Contact's IP, if provided nullable
origin - How contact was added
href - Link to contact details
account - Information about the account the contact is added to
event
|
Get notified when a contact is copied.
Payload example |
Description |
{
"type": "contact_copied",
"contact": {
"contactId": "abc123",
"email": "example@example.com",
"name": "Friend",
"campaign": {
"campaignId": "bcd234",
"campaignName": "my new campaign",
"href": "https://api.getresponse.com/v3/campaigns/bcd234"
},
"sourceCampaign": {
"campaignId": "mnb321",
"campaignName": "my source campaign",
"href": "https://api.getresponse.com/v3/campaigns/mnb321"
}
"href": "https://api.getresponse.com/v3/contacts/abc123"
},
"account": {
"accountId": "def456"
},
"event": {
"occurredAt": "2021-04-27T12:56:00+00:00"
}
}
|
type - Webhook event type - contact_copied
contact - Contact copied
contactId - New contact ID
email - New contact email address
name - New contact name nullable
campaign - Campaign (List) the contact is copied to
campaignId - ID of the campaign (list) the contact is copied to
campaignName - Name of the campaign (list) the contact is copied to
href - Link to the campaign (list) details
sourceCampaign - Campaign (List) the contact is copied from
campaignId - ID of the campaign (list) the contact is copied from
campaignName - Name of the campaign (list) the contact is copied from
href - Link to the campaign (list) details
href - Link to contact details
account - Information about the account the contact is added to
event
|
Get notified when a contact is moved.
Payload example |
Description |
{
"type": "contact_moved",
"contact": {
"contactId": "abc123",
"email": "example@example.com",
"name": "Friend",
"campaign": {
"campaignId": "bcd234",
"campaignName": "my new campaign name",
"href": "https://api.getresponse.com/v3/campaigns/bcd234"
},
"sourceCampaign": {
"campaignId": "mnb321",
"campaignName": "my previous campaign name",
"href": "https://api.getresponse.com/v3/campaigns/mnb321"
}
"href": "https://api.getresponse.com/v3/contacts/abc123"
},
"account": {
"accountId": "def456"
},
"event": {
"occurredAt": "2021-04-27T12:56:00+00:00"
}
}
|
type - Webhook event type - contact_moved
contact - Contact moved
contactId - Contact ID
email - Contact email address
name - Contact name nullable
campaign - Campaign (List) the contact is moved to
campaignId - ID of the campaign (list) the contact is moved to
campaignName - Name of the campaign (list) the contact is moved to
href - Link to the campaign (list) details
sourceCampaign - Campaign (List) the contact is moved from
campaignId - ID of the campaign (list) the contact is moved from
campaignName - Name of the campaign (list) the contact is moved from
href - Link to the campaign (list) details
href - Link to contact details
account - Information about the account the contact is added to
event
|
Get notified whenever a contact unsubscribes via unsubscribe link
Payload example |
Description |
{
"type": "contact_removed_link",
"contact": {
"contactId": "abc123",
"email": "example@example.com",
"name": "Friend",
"campaign": {
"campaignId": "bcd234",
"name": "my_first_campaign",
"href": "https://api.getresponse.com/v3/campaigns/bcd234"
}
},
"account": {
"accountId": "def456"
},
"event": {
"occurredAt": "2021-04-27T12:56:00+00:00"
}
}
|
type - Webhook event type - contact_removed_link
contact - Unsubscribed contact
contactId - ID of the contact
email - Email address of the contact
name - Name of the contact nullable
campaign - Campaign (List) a contact unsubscribed from
campaignId - ID of campaign (list) the contact unsubscribed from
name - Name of campaign (list) the contact unsubscribed from
href - Link to campaign (list) details
account - Information about the account
event
|