Marketplace

• OpenAPI Version: 3.1.0
• API Version: 1.0.0

Operations

POST app.authorization_request_declined

• Method: POST
• Path: app.authorization_request_declined
• Tags: app

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — A timestamp at which the event occurred.

• payload (required)

  object

  • app_id (required)

    string — The unique identifier for the app.

  • app_name (required)

    string — The app's name.

  • app_status (required)

    string, possible values: "published", "unpublished" — The app's status: * published * unpublished

  • app_type (required)

    string — The app's type.

  • request_id (required)

    string — The unique ID for this app installation request.

  • reviewer_email (required)

    string, format: email — The email address of the administrator who declined the request.

  • reviewer_name (required)

    string — The display name of the administrator who declined the request.

  • scope (required)

    string, possible values: "all_users_on_account", "specific_users" — The scope of the admin's review action: * all_users_on_account — The admin declined the request for all users on the account. * specific_users — The admin declined the request for specific selected users.

  • app_description

    string — The app's description.

  • reviewed_requests

    array — A list of user requests that were declined. When scope is all_users_on_account, this might be absent. When scope is specific_users, this includes the declined users.

    Items:

    • requester_email (required)

      string, format: email — The email of the user who requested to install the app.

    • requester_name (required)

      string — The name of the user who requested to install the app.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "request_id": "",
    "app_id": "",
    "app_name": "",
    "app_type": "",
    "app_status": "published",
    "app_description": "",
    "scope": "all_users_on_account",
    "reviewer_name": "",
    "reviewer_email": "",
    "reviewed_requests": [
      {
        "requester_name": "",
        "requester_email": ""
      }
    ]
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — A timestamp at which the event occurred.

• payload (required)

  object

  • app_id (required)

    string — The unique identifier for the app.

  • app_name (required)

    string — The app's name.

  • app_status (required)

    string, possible values: "published", "unpublished" — The app's status: * published * unpublished

  • app_type (required)

    string — The app's type.

  • request_id (required)

    string — The unique ID for this app installation request.

  • reviewer_email (required)

    string, format: email — The email address of the administrator who declined the request.

  • reviewer_name (required)

    string — The display name of the administrator who declined the request.

  • scope (required)

    string, possible values: "all_users_on_account", "specific_users" — The scope of the admin's review action: * all_users_on_account — The admin declined the request for all users on the account. * specific_users — The admin declined the request for specific selected users.

  • app_description

    string — The app's description.

  • reviewed_requests

    array — A list of user requests that were declined. When scope is all_users_on_account, this might be absent. When scope is specific_users, this includes the declined users.

    Items:

    • requester_email (required)

      string, format: email — The email of the user who requested to install the app.

    • requester_name (required)

      string — The name of the user who requested to install the app.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "request_id": "",
    "app_id": "",
    "app_name": "",
    "app_type": "",
    "app_status": "published",
    "app_description": "",
    "scope": "all_users_on_account",
    "reviewer_name": "",
    "reviewer_email": "",
    "reviewed_requests": [
      {
        "requester_name": "",
        "requester_email": ""
      }
    ]
  }
}

POST app_deauthorized

• Method: POST
• Path: app_deauthorized
• Tags: app_deauthorized

Request Body

Content-Type: application/json

• event

  string — The name of the event.

• payload

  object

  • account_id

    string — The user's account ID.

  • client_id

    string — The app's client ID.

  • deauthorization_time

    string, format: date-time — The date and time at which the user uninstalled the app.

  • event_ts

    number — The timestamp of the webhook event.

  • signature

    string — A unique ID for each instance of app deauthorization and uninstallation by the user.

  • user_id

    string — The user's ID.

Example:

{
  "event": "",
  "payload": {
    "user_id": "",
    "account_id": "",
    "client_id": "",
    "deauthorization_time": "",
    "signature": "",
    "event_ts": 1
  }
}

Responses

Status: 200

Content-Type: application/json

• event

  string — The name of the event.

• payload

  object

  • account_id

    string — The user's account ID.

  • client_id

    string — The app's client ID.

  • deauthorization_time

    string, format: date-time — The date and time at which the user uninstalled the app.

  • event_ts

    number — The timestamp of the webhook event.

  • signature

    string — A unique ID for each instance of app deauthorization and uninstallation by the user.

  • user_id

    string — The user's ID.

Example:

{
  "event": "",
  "payload": {
    "user_id": "",
    "account_id": "",
    "client_id": "",
    "deauthorization_time": "",
    "signature": "",
    "event_ts": 1
  }
}

POST app.authorization_request_created

• Method: POST
• Path: app.authorization_request_created
• Tags: app

Request Body

Content-Type: application/json

• event

  string — The name of the event.

• event_ts

  integer, format: int64 — A timestamp at which the event occurred.

• payload

  object

  • app_description

    string — The app's description.

  • app_link

    object — Information about the app's developer documentation URLs.

    • developer_documentation

      string, format: url — The app's documentation URL.

    • developer_privacy_policy

      string, format: url — The app's privacy policy URL.

    • developer_support

      string, format: url — The app's support URL.

    • developer_terms_of_use

      string, format: url — The app's Terms of Use URL.

  • app_name

    string — The app's name.

  • app_status

    string, possible values: "published", "development" — The app's status: * published * development

  • app_type

    string — The app's type.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "app_name": "",
    "app_type": "",
    "app_status": "published",
    "app_description": "",
    "app_link": {
      "developer_documentation": "",
      "developer_privacy_policy": "",
      "developer_support": "",
      "developer_terms_of_use": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event

  string — The name of the event.

• event_ts

  integer, format: int64 — A timestamp at which the event occurred.

• payload

  object

  • app_description

    string — The app's description.

  • app_link

    object — Information about the app's developer documentation URLs.

    • developer_documentation

      string, format: url — The app's documentation URL.

    • developer_privacy_policy

      string, format: url — The app's privacy policy URL.

    • developer_support

      string, format: url — The app's support URL.

    • developer_terms_of_use

      string, format: url — The app's Terms of Use URL.

  • app_name

    string — The app's name.

  • app_status

    string, possible values: "published", "development" — The app's status: * published * development

  • app_type

    string — The app's type.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "app_name": "",
    "app_type": "",
    "app_status": "published",
    "app_description": "",
    "app_link": {
      "developer_documentation": "",
      "developer_privacy_policy": "",
      "developer_support": "",
      "developer_terms_of_use": ""
    }
  }
}

POST app.authorization_request_approved

• Method: POST
• Path: app.authorization_request_approved
• Tags: app

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — A timestamp at which the event occurred.

• payload (required)

  object

  • app_id (required)

    string — The unique identifier for the app.

  • app_name (required)

    string — The app's name.

  • app_status (required)

    string, possible values: "published", "unpublished" — The app's status: * published * unpublished

  • app_type (required)

    string — The app's type.

  • request_id (required)

    string — The unique ID for this app installation request.

  • reviewer_email (required)

    string, format: email — The email address of the administrator who approved the request.

  • reviewer_name (required)

    string — The display name of the administrator who approved the request.

  • scope (required)

    string, possible values: "all_users_on_account", "specific_users" — The scope of the admin's review action: * all_users_on_account — The admin approved the request for all users on the account. * specific_users — The admin approved the request for specific selected users.

  • app_description

    string — The app's description.

  • reviewed_requests

    array — A list of user requests that were approved. When scope is all_users_on_account, this might be absent. When scope is specific_users, this includes the approved users.

    Items:

    • requester_email (required)

      string, format: email — The email of the user who requested to install the app.

    • requester_name (required)

      string — The name of the user who requested to install the app.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "request_id": "",
    "app_id": "",
    "app_name": "",
    "app_type": "",
    "app_status": "published",
    "app_description": "",
    "scope": "all_users_on_account",
    "reviewer_name": "",
    "reviewer_email": "",
    "reviewed_requests": [
      {
        "requester_name": "",
        "requester_email": ""
      }
    ]
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — A timestamp at which the event occurred.

• payload (required)

  object

  • app_id (required)

    string — The unique identifier for the app.

  • app_name (required)

    string — The app's name.

  • app_status (required)

    string, possible values: "published", "unpublished" — The app's status: * published * unpublished

  • app_type (required)

    string — The app's type.

  • request_id (required)

    string — The unique ID for this app installation request.

  • reviewer_email (required)

    string, format: email — The email address of the administrator who approved the request.

  • reviewer_name (required)

    string — The display name of the administrator who approved the request.

  • scope (required)

    string, possible values: "all_users_on_account", "specific_users" — The scope of the admin's review action: * all_users_on_account — The admin approved the request for all users on the account. * specific_users — The admin approved the request for specific selected users.

  • app_description

    string — The app's description.

  • reviewed_requests

    array — A list of user requests that were approved. When scope is all_users_on_account, this might be absent. When scope is specific_users, this includes the approved users.

    Items:

    • requester_email (required)

      string, format: email — The email of the user who requested to install the app.

    • requester_name (required)

      string — The name of the user who requested to install the app.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "request_id": "",
    "app_id": "",
    "app_name": "",
    "app_type": "",
    "app_status": "published",
    "app_description": "",
    "scope": "all_users_on_account",
    "reviewer_name": "",
    "reviewer_email": "",
    "reviewed_requests": [
      {
        "requester_name": "",
        "requester_email": ""
      }
    ]
  }
}