Send a test event
Sends one example event, with test: true and a fake contact, to the URL of a registration. Use it to check that your endpoint receives the events.
The URL receives a MAIL_REPLIED body. If the events of the registration include CAMPAIGN_ENDING, it receives a CAMPAIGN_ENDING body (date, campaign, id) instead.
The event is sent in the background: success: true means that it was sent, not that your endpoint accepted it. Check on your side that it arrived.
hookId is the id returned by GET /webhook, or the webhookId returned by POST /webhook for a single campaign. The webhookId returned with ALL_CAMPAIGNS is not a registration and answers 404.
Errors. 404 Webhook not found for an id that is not one of your registrations. 500 Internal server error for a value that is not a 24 character id. Both bodies also carry success: false.
Authorization
apiKey Your 48 character API key, sent as is (a Bearer prefix is tolerated). Create it at https://v3.emelia.io/settings/api.
In: header
Path Parameters
Id of the registration.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/webhook/6702c1d4e5f6a7b8c9d0e1f2/test" \ -H "Authorization: YOUR_API_KEY"{ "success": true}POSTCreate a webhook
Registers a URL on an advanced (multichannel) campaign, or on all of them.
GETList webhooks
Returns the activity webhooks registered on the campaigns of the authenticated account: legacy email campaigns (typeOfCampaign: email), legacy LinkedIn campaigns (linkedin) and advanced campaigns (advanced), whatever the