Skip to main content

Contentful Component

Use the Contentful component to manage Spaces, Environments, Organizations and more.

Component key: contentful

Description​

Contentful is a content management system (CMS) that allows developers to manage and deliver content across multiple platforms and devices.

Use the Contentful component to manage Spaces, Environments, Organizations and more.

API Reference Documentation: Contentful API Reference Documentation

Connections​

OAuth 2.0​

Create a new OAuth App:

  1. Login and navigate to the Developer Account Settings for OAuth applications
  2. Create a New Application
  3. Enter the Redirect URI as https://oauth2.prismatic.io/callback
  4. Additionally check the boxes for the applicable scopes: Content management read, Content management manage, Confidential
  5. Upon saving the application note the Client ID and Client Secret and enter them in the connection configuration of the integration.
InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for the API

https://be.contentful.com/oauth/authorize
Client ID

Client Identifier of your app for the API

Client Secret

Client Secret of your app for the API

Scopes

Space separated OAuth 2.0 permission scopes for the API

content_management_manage content_management_read
Token URL

The OAuth 2.0 Token URL for the API

https://be.contentful.com/oauth/token

Triggers​

Events Based​

Get notified when events occur in your space | key: eventsTrigger

InputNotesExample
Connection
Space ID

The ID of the space

yadj1kx9rmg0
Events

The events of the webhook

Entry.create

Webhook​

Receive and validate webhook requests from Contentful for webhooks you configure. | key: webhook

InputNotesExample
Connection

Data Sources​

Select Environment​

Select an environment from a dropdown menu | key: selectEnvironment | type: picklist

InputNotesExample
Connection
Data Source Return

The return value of the data source

id
Space ID

The ID of the space

yadj1kx9rmg0

Select Organization​

Select an organization from a dropdown menu | key: selectOrganization | type: picklist

InputNotesExample
Connection
Data Source Return

The return value of the data source

id

Select Space​

Select a space from a dropdown menu | key: selectSpace | type: picklist

InputNotesExample
Connection
Data Source Return

The return value of the data source

id

Actions​

Create Asset​

Create a new asset | key: createAsset

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Description

The description of the asset

Environment ID

The ID of the environment

staging
File

The file of the asset

Space ID

The ID of the space

yadj1kx9rmg0
Title

The title of the asset

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Playsam Streamliner"
      },
      "file": {
        "en-US": {
          "contentType": "image/jpeg",
          "fileName": "example.jpeg",
          "upload": "https://example.com/example.jpg"
        }
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "wtrHxeu3zEoEce2MokCSi",
      "type": "Asset",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Create Content Type​

Create a new content type | key: createContentType

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Description

The description of the content type

A blog post
Display Field

Field used as the main display field for Entries

title
Environment ID

The ID of the environment

staging
Content Type Fields

The fields of the content type

Content Type Name

The name of the content type

Blog Post
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "type": "ContentType",
      "id": "3ORKIAOaJqQWWg86MWkyOs",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "displayField": "title",
    "name": "Blog Post",
    "description": "A blog post",
    "fields": [
      {
        "id": "title",
        "name": "Title",
        "type": "Text",
        "localized": true,
        "required": true,
        "validations": [],
        "disabled": false,
        "omitted": false
      },
      {
        "id": "body",
        "name": "Body",
        "type": "Text",
        "localized": true,
        "required": true,
        "validations": [],
        "disabled": false,
        "omitted": false
      }
    ]
  }
}

Create Environment​

Create a new environment | key: createEnvironment

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Environment Name

The name of the environment

Staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "name": "master",
    "sys": {
      "type": "Environment",
      "id": "master",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "fm17kie1n0p4"
        }
      },
      "status": {
        "sys": {
          "type": "Link",
          "linkType": "Status",
          "id": "ready"
        }
      },
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "createdAt": "2024-01-29T18:33:02Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "updatedAt": "2024-01-29T18:33:02Z"
    }
  }
}

Create Space​

Create a new space | key: createSpace

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Default Locale

The default locale

en
Space Name

The name of the space

My Space
Organization ID

The ID of the organization

1Qz7ThNuABCytfP4oqkF12

{
  "data": {
    "sys": {
      "type": "Space",
      "id": "yadj1kx9rmg0",
      "version": 3,
      "organization": {
        "sys": {
          "id": "0D9ZC8rLWiw6x5qizZGiRs",
          "type": "Link",
          "linkType": "Organization"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "Contentful Example API"
  }
}

Create Webhook​

Create a new webhook | key: createWebhook

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Name

The name of the webhook

Example Webhook
Space ID

The ID of the space

yadj1kx9rmg0
Events

The events of the webhook

Entry.create
URL

The URL of the webhook

https://example.com/webhook

{
  "data": {
    "sys": {
      "type": "WebhookDefinition",
      "id": "0KzM2HxYr5O1pZ4SaUzK8h",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "My webhook",
    "url": "https://www.example.com",
    "topics": [
      "Entry.create",
      "ContentType.create",
      "*.publish",
      "Asset.*"
    ],
    "httpBasicUsername": "yolo",
    "headers": [
      {
        "key": "header1",
        "value": "value1"
      },
      {
        "key": "header2",
        "value": "value2"
      }
    ],
    "filters": [],
    "active": true
  }
}

Delete Asset​

Delete an existing asset | key: deleteAsset

InputNotesExample
Asset ID

The ID of the asset

wtrHxeu3zEoEce2MokCSi
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {}
}

Delete Environment​

Delete existing environment | key: deleteEnvironment

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {}
}

Delete Instanced Webhooks​

Delete all webhooks that point to a flow in this instance | key: deleteInstancedWebhooks

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Space ID

The ID of the space

yadj1kx9rmg0

Delete Space​

Delete an existing space | key: deleteSpace

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {}
}

Delete Upload​

Deletes a file from temporary data storage | key: deleteUpload

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0
Upload ID

The ID of the upload

2DNvIbYNELgqLJUkgTeIOV

{
  "data": {}
}

Delete Webhook​

Delete a webhook | key: deleteWebhook

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Space ID

The ID of the space

yadj1kx9rmg0
Webhook ID

The ID of the webhook

5KsDBWseXY6QegucYAoacS

{
  "data": {}
}

Get Asset​

Retrieve a single asset | key: getAsset

InputNotesExample
Asset ID

The ID of the asset

wtrHxeu3zEoEce2MokCSi
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Playsam Streamliner"
      },
      "file": {
        "en-US": {
          "contentType": "image/jpeg",
          "fileName": "example.jpeg",
          "upload": "https://example.com/example.jpg"
        }
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "wtrHxeu3zEoEce2MokCSi",
      "type": "Asset",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Get Bulk Action​

Retrieve a bulk action | key: getBulkAction

InputNotesExample
Bulk Action ID

The ID of the bulk action

5KsDBWseXY6QegucYAoacS
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "id": "<bulk_action_id>",
      "type": "BulkAction",
      "status": "<status>",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "createdAt `2020-01-01T13:00:00.000Z`": "",
      "updatedAt `2020-01-01T13:00:00.000Z`": "",
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      }
    },
    "action": "<action>",
    "payload": {
      "entities": {
        "items": [
          {
            "sys": {
              "id": "<entity_id>",
              "type": "Link",
              "linkType": "<Entry|Asset>",
              "version": 0
            }
          }
        ]
      }
    },
    "error": {
      "sys": {
        "id": "<error_type>",
        "type": "Error"
      }
    }
  }
}

Get Environment​

Retrieve a single environment | key: getEnvironment

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "name": "master",
    "sys": {
      "type": "Environment",
      "id": "master",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "fm17kie1n0p4"
        }
      },
      "status": {
        "sys": {
          "type": "Link",
          "linkType": "Status",
          "id": "ready"
        }
      },
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "createdAt": "2024-01-29T18:33:02Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "updatedAt": "2024-01-29T18:33:02Z"
    }
  }
}

Get Organization​

Retrieve an organization by ID | key: getOrganization

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Organization ID

The ID of the organization

1Qz7ThNuABCytfP4oqkF12

{
  "data": {
    "sys": {
      "type": "Organization",
      "id": "0D9ZC8rLWiw6x5qizZGiRs",
      "version": 1,
      "createdAt": "2015-05-18T11:29:46.809Z",
      "updatedAt": "2015-05-18T11:29:46.809Z"
    },
    "name": "My organization"
  }
}

Get Space​

Retrieve a single space | key: getSpace

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "type": "Space",
      "id": "yadj1kx9rmg0",
      "version": 3,
      "organization": {
        "sys": {
          "id": "0D9ZC8rLWiw6x5qizZGiRs",
          "type": "Link",
          "linkType": "Organization"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "Contentful Example API"
  }
}

Get Upload​

Retrieves an unmodified image | key: getUpload

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0
Upload ID

The ID of the upload

2DNvIbYNELgqLJUkgTeIOV

{
  "data": {
    "sys": {
      "type": "Upload",
      "id": "2DNvIbYNELgqLJUkgTeIOV",
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "expiresAt": "2015-05-18T11:29:46.809Z",
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Get Webhook​

Retrieve a single webhook | key: getWebhook

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Space ID

The ID of the space

yadj1kx9rmg0
Webhook ID

The ID of the webhook

5KsDBWseXY6QegucYAoacS

{
  "data": {
    "sys": {
      "type": "WebhookDefinition",
      "id": "0KzM2HxYr5O1pZ4SaUzK8h",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "My webhook",
    "url": "https://www.example.com",
    "topics": [
      "Entry.create",
      "ContentType.create",
      "*.publish",
      "Asset.*"
    ],
    "httpBasicUsername": "yolo",
    "headers": [
      {
        "key": "header1",
        "value": "value1"
      },
      {
        "key": "header2",
        "value": "value2"
      }
    ],
    "filters": [],
    "active": true
  }
}

List Assets​

Retrieve all assets of a space | key: listAssets

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": [
    {
      "fields": {
        "title": {
          "en-US": "Playsam Streamliner"
        },
        "file": {
          "en-US": {
            "contentType": "image/jpeg",
            "fileName": "example.jpeg",
            "upload": "https://example.com/example.jpg"
          }
        }
      },
      "metadata": {
        "tags": [
          {
            "sys": {
              "type": "Link",
              "linkType": "Tag",
              "id": "nyCampaign"
            }
          }
        ]
      },
      "sys": {
        "id": "wtrHxeu3zEoEce2MokCSi",
        "type": "Asset",
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "yadj1kx9rmg0"
          }
        },
        "environment": {
          "sys": {
            "type": "Link",
            "linkType": "Environment",
            "id": "staging"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      }
    }
  ]
}

List Content Types​

Retrieves all content types of a space | key: listContentTypes

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": [
    {
      "sys": {
        "type": "ContentType",
        "id": "3ORKIAOaJqQWWg86MWkyOs",
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "yadj1kx9rmg0"
          }
        },
        "environment": {
          "sys": {
            "type": "Link",
            "linkType": "Environment",
            "id": "staging"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      },
      "displayField": "title",
      "name": "Blog Post",
      "description": "A blog post",
      "fields": [
        {
          "id": "title",
          "name": "Title",
          "type": "Text",
          "localized": true,
          "required": true,
          "validations": [],
          "disabled": false,
          "omitted": false
        },
        {
          "id": "body",
          "name": "Body",
          "type": "Text",
          "localized": true,
          "required": true,
          "validations": [],
          "disabled": false,
          "omitted": false
        }
      ]
    }
  ]
}

List Environments​

Retrieve all environments in a space | key: listEnvironments

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": [
    {
      "name": "master",
      "sys": {
        "type": "Environment",
        "id": "master",
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "fm17kie1n0p4"
          }
        },
        "status": {
          "sys": {
            "type": "Link",
            "linkType": "Status",
            "id": "ready"
          }
        },
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "5QvxuP1Kp8mVrw3PVcOp4t"
          }
        },
        "createdAt": "2024-01-29T18:33:02Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "5QvxuP1Kp8mVrw3PVcOp4t"
          }
        },
        "updatedAt": "2024-01-29T18:33:02Z"
      }
    }
  ]
}

List Organizations​

Retrieve all organizations an account has access to | key: listOrganizations

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": [
    {
      "sys": {
        "type": "Organization",
        "id": "0D9ZC8rLWiw6x5qizZGiRs",
        "version": 1,
        "createdAt": "2015-05-18T11:29:46.809Z",
        "updatedAt": "2015-05-18T11:29:46.809Z"
      },
      "name": "My organization"
    }
  ]
}

List Spaces​

Retrieve all spaces an account has access to | key: listSpaces

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": [
    {
      "sys": {
        "type": "Space",
        "id": "yadj1kx9rmg0",
        "version": 3,
        "organization": {
          "sys": {
            "id": "0D9ZC8rLWiw6x5qizZGiRs",
            "type": "Link",
            "linkType": "Organization"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      },
      "name": "Contentful Example API"
    }
  ]
}

List Webhooks​

Retrieves all webhooks of a space | key: listWebhooks

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": [
    {
      "sys": {
        "type": "WebhookDefinition",
        "id": "0KzM2HxYr5O1pZ4SaUzK8h",
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "yadj1kx9rmg0"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      },
      "name": "My webhook",
      "url": "https://www.example.com",
      "topics": [
        "Entry.create",
        "ContentType.create",
        "*.publish",
        "Asset.*"
      ],
      "httpBasicUsername": "yolo",
      "headers": [
        {
          "key": "header1",
          "value": "value1"
        },
        {
          "key": "header2",
          "value": "value2"
        }
      ],
      "filters": [],
      "active": true
    }
  ]
}

Process Asset​

Process an asset | key: processAsset

InputNotesExample
Asset ID

The ID of the asset

wtrHxeu3zEoEce2MokCSi
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {}
}

Publish an asset​

Publishes an asset | key: publishAnAsset

InputNotesExample
Asset ID

The ID of the asset

wtrHxeu3zEoEce2MokCSi
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Playsam Streamliner"
      },
      "file": {
        "en-US": {
          "contentType": "image/jpeg",
          "fileName": "example.jpeg",
          "upload": "https://example.com/example.jpg"
        }
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "firstPublishedAt": "2015-05-15T13:38:11.311Z",
      "publishedCounter": 2,
      "publishedAt": "2015-05-15T13:38:11.311Z",
      "publishedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      },
      "publishedVersion": 9
    }
  }
}

Publish Bulk Action​

Publish a bulk action | key: publishBulkAction

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Items

The items of the bulk action

Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "id": "<bulk_action_id>",
      "type": "BulkAction",
      "status": "<status>",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "createdAt": "2020-01-01T13:00:00.000Z",
      "updatedAt": "2020-01-01T13:00:00.000Z",
      "space": {
        "sys": {
          "type": "Link",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "id": "staging"
        }
      }
    },
    "action": "<action>",
    "payload": {
      "entities": {
        "items": [
          {
            "sys": {
              "id": "<entity_id>",
              "type": "Link",
              "linkType": "<Entry|Asset>",
              "version": 0
            }
          }
        ]
      }
    },
    "error": {
      "sys": {
        "id": "<error_type>",
        "type": "Error"
      }
    }
  }
}

Raw Request​

Send raw HTTP request to Contentful | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

false
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/spaces), The base URL is already included (https://api.contentful.com). For example, to connect to https://api.contentful.com/spaces, only /spaces is entered in this field.

/spaces
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Unpublish an asset​

Unpublishes an asset | key: unpublishAnAsset

InputNotesExample
Asset ID

The ID of the asset

wtrHxeu3zEoEce2MokCSi
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Playsam Streamliner"
      },
      "file": {
        "en-US": {
          "contentType": "image/jpeg",
          "fileName": "example.jpeg",
          "upload": "https://example.com/example.jpg"
        }
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "wtrHxeu3zEoEce2MokCSi",
      "type": "Asset",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Unpublish Bulk Action​

Unpublish a bulk action | key: unpublishBulkAction

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Items

The items of the bulk action

Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "id": "<bulk_action_id>",
      "type": "BulkAction",
      "status": "<status>",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "createdAt": "2020-01-01T13:00:00.000Z",
      "updatedAt": "2020-01-01T13:00:00.000Z",
      "space": {
        "sys": {
          "type": "Link",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "id": "staging"
        }
      }
    },
    "action": "<action>",
    "payload": {
      "entities": {
        "items": [
          {
            "sys": {
              "id": "<entity_id>",
              "type": "Link",
              "linkType": "<Entry|Asset>",
              "version": 0
            }
          }
        ]
      }
    },
    "error": {
      "sys": {
        "id": "<error_type>",
        "type": "Error"
      }
    }
  }
}

Update Asset​

Update an existing asset | key: updateAsset

InputNotesExample
Asset ID

The ID of the asset

wtrHxeu3zEoEce2MokCSi
Connection
Debug Request

Enabling this flag will log out the current request.

false
New Asset Description

The updated description of the asset. Locale key must match the original locale of the asset to be updated

Environment ID

The ID of the environment

staging
Space ID

The ID of the space

yadj1kx9rmg0
Title

The updated title of the asset. Locale key must match the original locale of the asset to be updated

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Playsam Streamliner"
      },
      "file": {
        "en-US": {
          "contentType": "image/jpeg",
          "fileName": "example.jpeg",
          "upload": "https://example.com/example.jpg"
        }
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "wtrHxeu3zEoEce2MokCSi",
      "type": "Asset",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Update Content Type​

Update an existing content type | key: updateContentType

InputNotesExample
Connection
Content Type ID

The ID of the content type

2PqfXUJwE8qSYKuM0U6w8M
Debug Request

Enabling this flag will log out the current request.

false
Description

The updated description for the content type

A blog post
Display Field

The updated Field used as the main display field for Entries

title
Environment ID

The ID of the environment

staging
Content Type Fields

The updated fields for the content type

Content Type Name

The updated name for the content type

Blog Post
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "type": "ContentType",
      "id": "3ORKIAOaJqQWWg86MWkyOs",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "displayField": "title",
    "name": "Blog Post",
    "description": "A blog post",
    "fields": [
      {
        "id": "title",
        "name": "Title",
        "type": "Text",
        "localized": true,
        "required": true,
        "validations": [],
        "disabled": false,
        "omitted": false
      },
      {
        "id": "body",
        "name": "Body",
        "type": "Text",
        "localized": true,
        "required": true,
        "validations": [],
        "disabled": false,
        "omitted": false
      }
    ]
  }
}

Update Environment​

Edit an existing environment | key: updateEnvironment

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Environment ID

The ID of the environment

staging
Environment Name

The updated name for the environment

Staging
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "name": "master",
    "sys": {
      "type": "Environment",
      "id": "master",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "fm17kie1n0p4"
        }
      },
      "status": {
        "sys": {
          "type": "Link",
          "linkType": "Status",
          "id": "ready"
        }
      },
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "createdAt": "2024-01-29T18:33:02Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "updatedAt": "2024-01-29T18:33:02Z"
    }
  }
}

Update Organization​

Update an organization security contact an admin or owner has access to | key: updateOrganization

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Organization ID

The ID of the organization

1Qz7ThNuABCytfP4oqkF12
Security ID

The ID of the security contact

srdfsguf8325yusf24

{
  "data": {
    "email": "example@gmail.com",
    "sys": {
      "type": "Security Contact",
      "id": "srdfsguf8325yusf24",
      "version": "1",
      "organization": {
        "sys": {
          "id": "0D9ZC8rLWiw6x5qizZGiRs",
          "type": "Link",
          "linkType": "Organization"
        }
      },
      "createdBy": {
        "sys": {
          "id": "1xGZIRXr2WPnsLkKfREo0z",
          "type": "Link",
          "linkType": "User"
        }
      },
      "updatedBy": {
        "sys": {
          "id": "1xGZIRXr2WPnsLkKfREo0z",
          "type": "Link",
          "linkType": "User"
        }
      },
      "createdAt": "2019-05-18T11:39:46.809Z",
      "updatedAt": "2019-05-18T11:39:46.809Z"
    }
  }
}

Update Space​

Edit an existing Space | key: updateSpace

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Space ID

The ID of the space

yadj1kx9rmg0
Space Name

The updated name for the space

My Space

{
  "data": {
    "sys": {
      "type": "Space",
      "id": "yadj1kx9rmg0",
      "version": 3,
      "organization": {
        "sys": {
          "id": "0D9ZC8rLWiw6x5qizZGiRs",
          "type": "Link",
          "linkType": "Organization"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "Contentful Example API"
  }
}

Update Webhook​

Update an existing webhook | key: updateWebhook

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Name

The updated name for the webhook

Example Webhook
Space ID

The ID of the space

yadj1kx9rmg0
Webhook ID

The ID of the webhook

5KsDBWseXY6QegucYAoacS

{
  "data": {
    "sys": {
      "type": "WebhookDefinition",
      "id": "0KzM2HxYr5O1pZ4SaUzK8h",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "My webhook",
    "url": "https://www.example.com",
    "topics": [
      "Entry.create",
      "ContentType.create",
      "*.publish",
      "Asset.*"
    ],
    "httpBasicUsername": "yolo",
    "headers": [
      {
        "key": "header1",
        "value": "value1"
      },
      {
        "key": "header2",
        "value": "value2"
      }
    ],
    "filters": [],
    "active": true
  }
}

Upload File​

Upload a file to temporary file storage | key: uploadFile

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
File Contents

The contents to write to a file. This can be a string of text, it can be binary data that was generated in a previous step.

My File Contents
Space ID

The ID of the space

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "type": "Upload",
      "id": "2DNvIbYNELgqLJUkgTeIOV",
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "expiresAt": "2015-05-18T11:29:46.809Z",
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}