ModuleRegistrationResponse.json

{
  "type" : "module_registration_response",
  "id" : "242e15a9-2066-47b2-84f8-0505ad2ea0f0",
  "timestamp_ms" : 1714592744067,
  "firehose_version" : "3.2.0",
  "sdk_version" : "3.2.0",
  "name" : "Your Company Name",
  "description" : "A description of your <a href=''>company</a> and services. Inline HTML markup is permitted.",
  "version" : "1.0",
  "permissions" : {
    "device_identities" : [ {
      "type" : "ios_advertising_id",
      "encoding" : "raw",
      "required" : true
    }, {
      "type" : "google_advertising_id",
      "encoding" : "raw",
      "required" : true
    } ],
    "user_identities" : [ {
      "type" : "email",
      "encoding" : "sha256",
      "required" : false
    } ],
    "partner_identities" : [ {
      "type" : "partner_id",
      "encoding" : "raw",
      "required" : false
    } ],
    "allow_consent_state" : true,
    "allow_access_mpid" : true
  },
  "event_processing_registration" : {
    "account_settings" : [ {
      "type" : "text",
      "id" : "apiKey",
      "name" : "API Key",
      "description" : "Secret key to use the API, provided by your account manager",
      "visible" : true,
      "required" : true,
      "confidential" : true
    }, {
      "type" : "text",
      "id" : "customerId",
      "name" : "Customer ID",
      "description" : "Internal customer ID, provided by your account manager",
      "visible" : true,
      "required" : true,
      "confidential" : false
    } ],
    "supported_event_types" : [ "custom_event", "session_start", "session_end" ],
    "supported_runtime_environments" : [ "ios", "android" ],
    "supported_system_notification_types" : [ "gdpr_consent_state" ],
    "max_data_age_hours" : 24,
    "authentication" : {
      "type" : "oauth2",
      "authorization_url" : "TEST_EVENT_AUTHORIZATION_URL",
      "refresh_url" : "TEST_EVENT_REFRESH_URL",
      "token_url" : "TEST_EVENT_TOKEN_URL",
      "grant_type" : "authorization_code",
      "default_expires_in" : 2000,
      "client_id" : "TEST_EVENT_CLIENT_ID",
      "access_token_type" : "custom_header",
      "custom_header_name" : "TEST_EVENT_CUSTOMER_HEADER_NAME",
      "param_client_id_name" : "TEST_EVENT_PARAM_CLIENT_ID_NAME",
      "param_secret_name" : "TEST_EVENT_PARAM_SECRET_NAME",
      "scopes" : [ {
        "name" : "TEST_EVENT_SCOPE_NAME_1",
        "description" : "TEST_EVENT_SCOPE_DESCRIPTION_1"
      } ]
    }
  },
  "audience_processing_registration" : {
    "account_settings" : [ {
      "type" : "text",
      "id" : "apiKey",
      "name" : "API Key",
      "description" : "Secret key to use the API, provided by your account manager",
      "visible" : true,
      "required" : true,
      "confidential" : true
    }, {
      "type" : "text",
      "id" : "customerId",
      "name" : "Customer ID",
      "description" : "Internal customer ID, provided by your account manager",
      "visible" : true,
      "required" : true,
      "confidential" : false
    } ],
    "authentication" : {
      "type" : "oauth2",
      "authorization_url" : "TEST_AUTHORIZATION_URL",
      "refresh_url" : "TEST_REFRESH_URL",
      "token_url" : "TEST_TOKEN_URL",
      "grant_type" : "authorization_code",
      "default_expires_in" : 2000,
      "client_id" : "TEST_CLIENT_ID",
      "access_token_type" : "custom_header",
      "custom_header_name" : "TEST_CUSTOMER_HEADER_NAME",
      "param_client_id_name" : "TEST_PARAM_CLIENT_ID_NAME",
      "param_secret_name" : "TEST_PARAM_SECRET_NAME",
      "scopes" : [ {
        "name" : "TEST_SCOPE_NAME_1",
        "description" : "TEST_SCOPE_DESCRIPTION_1"
      } ]
    },
    "bulk_configuration" : {
      "bulk_forward_wait_for_messages" : 4,
      "bulk_forward_wait_in_minutes" : 30
    },
    "audience_subscription_settings" : [ {
      "type" : "boolean",
      "id" : "audienceType",
      "name" : "Suppression Audience",
      "description" : "If enabled, this audience will be used for suppression.",
      "visible" : true,
      "default_value" : false,
      "checked" : false
    } ]
  },
  "dsr_processing_registration" : {
    "account_settings" : [ {
      "type" : "text",
      "id" : "webhookUrl",
      "name" : "Webhook URL",
      "description" : "The url of your integration.",
      "visible" : true,
      "required" : true,
      "confidential" : false
    } ],
    "supported_dsr_types" : [ "erasure" ],
    "domain" : "TEST_DOMAIN"
  }
}