Skip to content

Latest commit

 

History

History
152 lines (116 loc) · 4.97 KB

EventApi.md

File metadata and controls

152 lines (116 loc) · 4.97 KB

EventApi

All URIs are relative to https://api.sendx.io/api/v1/rest

Method HTTP request Description
createRevenueEvent POST /events/revenue Record a revenue event for a specific contact
pushCustomEvent POST /events/custom Push a custom event associated with a contact

createRevenueEvent

EventResponse createRevenueEvent(revenueEventRequest)

Record a revenue event for a specific contact

Records a revenue event, which can be attributed to campaigns, drips, workflows, or other sources of user interaction.

Example

// Import classes:
import sendx_java_sdk.ApiClient;
import sendx_java_sdk.ApiException;
import sendx_java_sdk.Configuration;
import sendx_java_sdk.auth.*;
import sendx_java_sdk.models.*;
import sendx_java_sdk.EventApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sendx.io/api/v1/rest");
    
    // Configure API key authorization: apiKeyAuth
    ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
    apiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //apiKeyAuth.setApiKeyPrefix("Token");

    EventApi apiInstance = new EventApi(defaultClient);
    RevenueEventRequest revenueEventRequest = new RevenueEventRequest(); // RevenueEventRequest | 
    try {
      EventResponse result = apiInstance.createRevenueEvent(revenueEventRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EventApi#createRevenueEvent");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
revenueEventRequest RevenueEventRequest

Return type

EventResponse

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Revenue event recorded successfully. -
400 Invalid request parameters. -
500 Internal server error. -

pushCustomEvent

EventResponse pushCustomEvent(customEventRequest)

Push a custom event associated with a contact

Pushes a custom event with properties and values for a specified contact.

Example

// Import classes:
import sendx_java_sdk.ApiClient;
import sendx_java_sdk.ApiException;
import sendx_java_sdk.Configuration;
import sendx_java_sdk.auth.*;
import sendx_java_sdk.models.*;
import sendx_java_sdk.EventApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sendx.io/api/v1/rest");
    
    // Configure API key authorization: apiKeyAuth
    ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
    apiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //apiKeyAuth.setApiKeyPrefix("Token");

    EventApi apiInstance = new EventApi(defaultClient);
    CustomEventRequest customEventRequest = new CustomEventRequest(); // CustomEventRequest | 
    try {
      EventResponse result = apiInstance.pushCustomEvent(customEventRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EventApi#pushCustomEvent");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
customEventRequest CustomEventRequest

Return type

EventResponse

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Custom event created successfully. -
400 Invalid request parameters. -
500 Internal server error. -