Webhook notification

Webhook

Webhooks are only used for native ads and are optional.

From the Adrop console, go to project, then select Project settings in the left navigation menu to provide a webhook URL. By providing a webhook URL, You can receive real-time notifications whenever advertiser information or ad creatives are created, updated or deleted.

Providing a webhook URL

Registering a webhook URL

To register a webhook URL:

From the left navigation menu, select Project settings.
Click the pencil icon in the Webhook URL field.
Type your webhook URL to receive.
Press "Save".

Providing client credentials

You will be able to see the Client Credentials card after registering your webhook URL. It is optional. After you provide the Client Credentials, the Adrop server will send a POST request using those credentials.

To provide a client credential:

Click the pencil icon in the Client Credentials field.
Type your client credential.
Press "Save".

Receiving information

Once you provide a webhook URL, you will be able to receive information about advertiser accounts and creatives in real time whenever they are created, updated, or deleted. This information will be sent to your webhook URL.

Event formats

// Advertiser account created
{
  "type": "AD_ACCOUNT_CREATED",
  "account": {
    "id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "advertiser": "",
    "icon": "",
    "cover": "",
    "advertiserURL": ""
  }
}

// Advertiser account updated
{
  "type": "AD_ACCOUNT_UPDATED",
  "account": {
    "id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "advertiser": "AdropAds",
    "icon": "https://my-icon.png",
    "cover": "https://my-cover.png",
    "advertiserURL": "https://openrhapsody.com"
  }
}

// Advertiser account deleted
{
  "type": "AD_ACCOUNT_DELETED",
  "account": {
    "id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "advertiser": "AdropAds",
    "icon": "https://my-icon.png",
    "cover": "https://my-cover.png",
    "advertiserURL": "https://openrhapsody.com"
  }
}

// Creative created
{
  "type": "CREATIVE_CREATED",
  "creative": {
    "account_id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "id": "01HP3R4AMGWN5JWQC8E7B0HKAV:01HP3RN8WTVC91NJEYWVD69HT8:BAnNDJJSJeS05Fb2RMnCO",
    "creative": "<html>..<html>",
    "headline": "headline text",
    "body": "body Text",
    "callToAction": "Go Now",
    "destinationURL": "https://adrop.io"
  }
}

// Creative updated
{
  "type": "CREATIVE_UPDATED",
  "creative": {
    "account_id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "id": "01HP3R4AMGWN5JWQC8E7B0HKAV:01HP3RN8WTVC91NJEYWVD69HT8:BAnNDJJSJeS05Fb2RMnCO",
    "creative": "<html>..<html>",
    "headline": "changed headline text",
    "body": "changed body Text",
    "callToAction": "Go Now",
    "destinationURL": "https://adrop.io"
  }
}

// Creative deleted
{
  "type": "CREATIVE_DELETED",
  "creative": {
    "account_id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "id": "01HP3R4AMGWN5JWQC8E7B0HKAV:01HP3RN8WTVC91NJEYWVD69HT8:BAnNDJJSJeS05Fb2RMnCO",
    "creative": "<html>..<html>",
    "headline": "changed headline text",
    "body": "changed body Text",
    "callToAction": "Go Now",
    "destinationURL": "https://adrop.io"
  }
}

Tagging information

You can register additional information (tag) you want about the Account ID or Creative ID received through a webhook in JSON format on the Adrop server.

You can check the tag data through the accountTag or creativeTag field when receiving advertisement.

Authorization

You need an access token to make a POST request for tagging. You can find your access token in the Authorization card after registering your webhook URL.

Requesting to register tag information

To request to register tag information:

Include your access token in the request header as Authorization.
POST request by the following POST https://api-rest.adrop.io/tag Docs.

You can now receive the information you tagged in the accountTag or creativeTag field whenever you retrieve an ad.

PreviousSet up projects using API NextCreate your Ad unit

Last updated 2 months ago