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:

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

Triggers

Events Based

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

Webhook

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

Data Sources

Select Environment

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

Select Organization

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

Select Space

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

Actions

Create Asset

Create a new asset | key: createAsset

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "data": {}
}

Delete Environment

Delete existing environment | key: deleteEnvironment

Output Example Payload

{
  "data": {}
}

Delete Instanced Webhooks

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

Delete Space

Delete an existing space | key: deleteSpace

Output Example Payload

{
  "data": {}
}

Delete Upload

Deletes a file from temporary data storage | key: deleteUpload

Output Example Payload

{
  "data": {}
}

Delete Webhook

Delete a webhook | key: deleteWebhook

Output Example Payload

{
  "data": {}
}

Get Asset

Retrieve a single asset | key: getAsset

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "data": {}
}

Publish an asset

Publishes an asset | key: publishAnAsset

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Unpublish an asset

Unpublishes an asset | key: unpublishAnAsset

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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

Output Example Payload

{
  "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"
        }
      }
    }
  }
}

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

Description​

Connections​

OAuth 2.0​

Triggers​

Events Based​

Webhook​

Data Sources​

Select Environment​

Select Organization​

Select Space​

Actions​

Create Asset​

Output Example Payload​

Create Content Type​

Output Example Payload​

Create Environment​

Output Example Payload​

Create Space​

Output Example Payload​

Create Webhook​

Output Example Payload​

Delete Asset​

Output Example Payload​

Delete Environment​

Output Example Payload​

Delete Instanced Webhooks​

Delete Space​

Output Example Payload​

Delete Upload​

Output Example Payload​

Delete Webhook​

Output Example Payload​

Get Asset​

Output Example Payload​

Get Bulk Action​

Output Example Payload​

Get Environment​

Output Example Payload​

Get Organization​

Output Example Payload​

Get Space​

Output Example Payload​

Get Upload​

Output Example Payload​

Get Webhook​

Output Example Payload​

List Assets​

Output Example Payload​

List Content Types​

Output Example Payload​

List Environments​

Output Example Payload​

List Organizations​

Output Example Payload​

List Spaces​

Output Example Payload​

List Webhooks​

Output Example Payload​

Process Asset​

Output Example Payload​

Publish an asset​

Output Example Payload​

Publish Bulk Action​

Output Example Payload​

Raw Request​

Unpublish an asset​

Output Example Payload​

Unpublish Bulk Action​

Output Example Payload​

Update Asset​

Output Example Payload​

Update Content Type​

Output Example Payload​

Update Environment​

Output Example Payload​

Update Organization​

Output Example Payload​

Update Space​

Output Example Payload​

Description

Connections

OAuth 2.0

Triggers

Events Based

Webhook

Data Sources

Select Environment

Select Organization

Select Space

Actions

Create Asset

Output Example Payload

Create Content Type

Output Example Payload

Create Environment

Output Example Payload

Create Space

Output Example Payload

Create Webhook

Output Example Payload

Delete Asset

Output Example Payload

Delete Environment

Output Example Payload

Delete Instanced Webhooks

Delete Space

Output Example Payload

Delete Upload

Output Example Payload

Delete Webhook

Output Example Payload

Get Asset

Output Example Payload

Get Bulk Action

Output Example Payload

Get Environment

Output Example Payload

Get Organization

Output Example Payload

Get Space

Output Example Payload

Get Upload

Output Example Payload

Get Webhook

Output Example Payload

List Assets

Output Example Payload

List Content Types

Output Example Payload

List Environments

Output Example Payload

List Organizations

Output Example Payload

List Spaces

Output Example Payload

List Webhooks

Output Example Payload

Process Asset

Output Example Payload

Publish an asset

Output Example Payload

Publish Bulk Action

Output Example Payload

Raw Request

Unpublish an asset

Output Example Payload

Unpublish Bulk Action

Output Example Payload

Update Asset

Output Example Payload

Update Content Type

Output Example Payload

Update Environment

Output Example Payload

Update Organization

Output Example Payload

Update Space

Output Example Payload

Update Webhook